Skip to content

Instantly share code, notes, and snippets.

@weex
Forked from aeble/mastodon-docker-setup.md
Last active November 5, 2023 20:39
  • Star 1 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
Star You must be signed in to star a gist
Save weex/265cfc6d1f05589c56d580f24089ecd5 to your computer and use it in GitHub Desktop.
Ecko Docker Setup

Ecko Docker Setup

Setting up

Clone Ecko's repository.

# Clone Ecko to ~/ecko directory
git clone https://github.com/magicstone-dev/ecko.git
# Change directory to ~/ecko
cd ~/ecko

Review the settings in docker-compose.yml.

Getting the Ecko image

Installing Docker containers

If you're not making any local code changes or customizations on your instance, you can use a prebuilt Docker image to avoid the time and resource consumption of a build.

  1. Open docker-compose.yml in your favorite text editor.
  2. Add environment variables to the db section:
    environment:
      - POSTGRES_PASSWORD: xyz <-- choose a safe one, 20-30 chars
      - POSTGRES_DB: ecko_production
      - POSTGRES_USER: ecko
      - POSTGRES_HOST_AUTH_METHOD: trust
  3. To use pre-built images comment out the build: . lines for the web, streaming, and sidekiq services.
  4. Save the file and exit the text editor.
  5. Run docker-compose build to either pull or build the necessary container images.
  6. Create the public/system dir with mkdir public/system
  7. Set correct file-owner with sudo chown -R 991:991 public/system

Configuration

Next generate a configuration with:

docker-compose run --rm web bundle exec rake mastodon:setup

This is an interactive wizard that will guide you through the options and generate app secrets.

  1. Enter the Fully Qualified Domain Name (FQDN) of your Ecko instance.
  2. Select if you want a Single User instance (not recommended, but if you prefer, use that).
  3. Obviously, you are running Ecko in a docker instance, so type Y (or hit return, as it's the default)
  4. The PostgreSQL host is db, the port is 5432 (again, default), the database is ecko_production, the database user is ecko and the password is the one you chose and put into docker-compose.yml.
  5. The redis server is redis, the port is 6379 and the password is empty.
  6. If you want to store uploaded files on the cloud, enter Y here and put in the necessary data.
  7. If you want to send emails from the local machine, enter Y. I chose N and was able to send email via a free mailgun account. Accept the default port then enter the user and password for the email sending account. Select the SMTP authentication type plain and none for OpenSSL verify mode. Choose what sender address the emails will have. ecko@*yourdomain.com* is a decent possibility.

Now it will output your configuration. Copy and paste that into the .env.production file.

The wizard will setup the database schema and precompile assets. After it's done, you can launch Mastodon with:

docker-compose up -d

Reverse Proxy

You need a reverse proxy in front of your Ecko instance. The most used and best documented for Ecko is nginx. In case you have an Apache running on port 80 anyway, you can also use that apache2 instance as a reverse proxy.

nginx Configuration

You need to configure nginx to serve your Ecko instance.

Copy the example nginx.conf to a specific one for your domain:

sudo cp dist/nginx.conf /etc/nginx/sites-available/example.com.conf

Then edit the file to replace example.com with your domain, and adust the root lines so they point to your installation. In my case I had to change the username and remove live/

Activate the configuration you added:

sudo ln -s ../sites-available/example.com.conf /etc/nginx/sites-enabled

SSL setup with Let's Encrypt

This depends on your host operating system. My experience is that DigitalOcean's setup documents work well for multiple Ubuntu and Debian versions.

Restart Nginx

To finish up, restart nginx with sudo systemctl reload nginx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment