https://github.com/evansims/mastodon.evansims.com
My personal Mastodon instance configuration
https://github.com/evansims/mastodon.evansims.com
docker docker-compose dokploy mastodon
Last synced: about 2 months ago
JSON representation
My personal Mastodon instance configuration
- Host: GitHub
- URL: https://github.com/evansims/mastodon.evansims.com
- Owner: evansims
- License: apache-2.0
- Created: 2025-07-27T03:54:53.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-27T05:26:59.000Z (11 months ago)
- Last Synced: 2026-03-30T05:38:58.017Z (3 months ago)
- Topics: docker, docker-compose, dokploy, mastodon
- Homepage: https://mastodon.evansims.com
- Size: 31.3 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mastodon.evansims.com
This repository contains the Docker Compose configuration for my personal Mastodon instance at [mastodon.evansims.com](https://mastodon.evansims.com), supporting multiple accounts under the [evansims.com](https://evansims.com) domain.
## Features
- Multi-account support (hello@evansims.com, photos@evansims.com, etc.)
- Deployed via [Dokploy](https://dokploy.com)
- Automated dependency updates via Dependabot
- Dedicated admin container for maintenance tasks
- PostgreSQL 14 for data storage
- Redis for caching and queues
## Prerequisites
- Dokploy instance running
- Domain configured (mastodon.evansims.com)
- SSL certificates configured in Dokploy
- SMTP service for email delivery (e.g., Mailgun)
## Deployment Steps
### 1. Create New Application in Dokploy
1. Go to your Dokploy dashboard
2. Create a new application
3. Select "Docker Compose" as the deployment type
4. Connect your Git repository
### 2. Environment Variables
In Dokploy's environment variables section, add all variables from `.env.production.example`:
**Critical Variables to Set:**
- `LOCAL_DOMAIN=evansims.com`
- `WEB_DOMAIN=mastodon.evansims.com`
- `SECRET_KEY_BASE` - Generate with: `openssl rand -base64 64`
- `OTP_SECRET` - Generate with: `openssl rand -base64 64`
- `VAPID_PRIVATE_KEY` & `VAPID_PUBLIC_KEY` - See generation instructions below
- `ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY` - See generation instructions below
- `ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT` - See generation instructions below
- `ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY` - See generation instructions below
- `DB_HOST=db`
- `DB_USER=postgres`
- `DB_NAME=postgres`
- `DB_PASS` - Leave empty (trust authentication)
- `DB_PORT=5432`
- `REDIS_HOST=redis`
- `REDIS_PORT=6379`
- `SINGLE_USER_MODE=false`
- `RAILS_ENV=production`
- `NODE_ENV=production`
- SMTP credentials for your email provider
**Rate Limiting (recommended values for personal use):**
- `THROTTLE_API_LIMIT=10000` - API requests per period (very permissive)
- `THROTTLE_API_PERIOD=300` - Period in seconds (5 minutes)
- `THROTTLE_MEDIA_LIMIT=1000` - Media uploads per period (essentially unlimited)
- `THROTTLE_MEDIA_PERIOD=300` - Media period in seconds (5 minutes)
- `THROTTLE_FOLLOW_LIMIT=10000` - Follows per day (essentially unlimited)
- `THROTTLE_FOLLOW_PERIOD=86400` - Follow period (24 hours)
**Generating Required Keys:**
1. First, deploy with minimal config to get containers running
2. Generate encryption keys:
```bash
docker exec -it [web_container_name] bin/rails db:encryption:init
```
Copy the three encryption keys to Dokploy environment variables
3. Generate VAPID keys:
```bash
docker exec -it [web_container_name] bundle exec rake mastodon:webpush:generate_vapid_key
```
Copy both keys to Dokploy environment variables
4. Redeploy to apply all environment variables
### 3. Initial Setup Commands
The docker-compose includes an **admin** container specifically for running maintenance commands. This container stays running and won't crash even if the database isn't initialized.
1. In Dokploy's dashboard, go to your Mastodon application
2. Find the **admin** container
3. Click on "Terminal" to open a shell
4. Run these commands:
```bash
# Initialize the database (first time only)
bundle exec rake db:setup
# Create your admin account
bin/tootctl accounts create hello --email hello@evansims.com --confirmed --role Owner
bin/tootctl accounts approve hello
# Create additional accounts as needed
bin/tootctl accounts create photos --email photos@evansims.com --confirmed --role Moderator
```
After running `db:setup`, your web container should start successfully.
### 4. Domain Configuration
Configure your Dokploy proxy/reverse proxy to:
- Route HTTPS traffic to port 3000
- Route `/api/v1/streaming` to port 4000
Ensure Dokploy is configured to:
- Serve the app at https://mastodon.evansims.com
- Handle SSL termination
- Pass proper headers (X-Forwarded-For, X-Forwarded-Proto)
## Maintenance
### Using the Admin Container
The admin container is available for all maintenance tasks:
- Database migrations: `bundle exec rake db:migrate`
- Clear cache: `bin/tootctl cache clear`
- Media cleanup: `bin/tootctl media remove`
- Account management: `bin/tootctl accounts`
### Viewing Logs
Use Dokploy's log viewer or:
```bash
# Find container name first
docker ps | grep mastodon
# Then view logs
docker logs -f [container-name]
```
### Updating Mastodon
1. Update the image version in docker-compose.yml
2. Push to your repository
3. Trigger deployment in Dokploy
4. Run migrations if needed via the admin container:
```bash
bundle exec rake db:migrate
```
### Managing Accounts
**Creating New Accounts:**
```bash
bin/tootctl accounts create USERNAME --email EMAIL@evansims.com --confirmed
```
**Account Roles:**
- **Owner**: Full admin access (use for your main account)
- **Admin**: Administrative access
- **Moderator**: Can moderate content
- **User**: Regular user (default)
**Reset Password:**
```bash
bin/tootctl accounts modify USERNAME --reset-password
```
**List All Accounts:**
```bash
bin/tootctl accounts list
```
### Backup
Configure Dokploy's backup feature to regularly backup the volumes:
- `postgres_data` (critical)
- `public_system` (user uploads)
- `redis_data` (optional, just cache)
## Architecture
- **web**: Main Rails application serving the Mastodon UI
- **streaming**: Node.js server for real-time updates
- **sidekiq**: Background job processor
- **admin**: Maintenance container for administrative tasks
- **db**: PostgreSQL 14 database
- **redis**: Redis cache and queue
## Security Notes
- Environment variables are managed through Dokploy UI
- The `.gitignore` prevents committing secrets
- Public registrations are disabled by default
- All secrets are stored in Dokploy, not in the repository
## License
This configuration is provided as-is for reference purposes.