Hometown is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones with some extra features..

Supported Architectures

Simply pulling dev.cat-enby.club/nikurasu/hometown:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag	Available	Description
latest	✅	Stable releases.
develop	✅	Pre-releases only.

Application Setup

To generate keys for SECRET_KEY_BASE & OTP_SECRET run docker run --rm -it -w /app/www --entrypoint rake dev.cat-enby.club/nikurasu/mastodon secret once for each.

To generate keys for VAPID_PRIVATE_KEY & VAPID_PUBLIC_KEY run docker run --rm -it -w /app/www --entrypoint rake dev.cat-enby.club/nikurasu/mastodon mastodon:webpush:generate_vapid_key

To use tootctl you can run something like docker exec -it -w /app/www mastodon bin/tootctl <command>

This container requires separate postgres and redis instances to run.

We support all of the official environment variables for configuration. In place of adding them all to your run/compose you can use an env file such as this example from the upstream project.

For more information check out the mastodon documentation.

Strict reverse proxies

This image automatically redirects to https with a self-signed certificate. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.

Usage

Here are some example snippets to help you get started creating a container.

docker-compose (recommended)

---
version: "2.1"
services:
  hometown:
    image: dev.cat-enby.club/nikurasu/hometown:latest
    container_name: hometown
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/New_York
      - LOCAL_DOMAIN=example.com
      - REDIS_HOST=redis
      - REDIS_PORT=6379
      - DB_HOST=db
      - DB_USER=mastodon
      - DB_NAME=mastodon
      - DB_PASS=mastodon
      - DB_PORT=5432
      - ES_ENABLED=false
      - SECRET_KEY_BASE=
      - OTP_SECRET=
      - VAPID_PRIVATE_KEY=
      - VAPID_PUBLIC_KEY=
      - SMTP_SERVER=mail.example.com
      - SMTP_PORT=25
      - SMTP_LOGIN=
      - SMTP_PASSWORD=
      - SMTP_FROM_ADDRESS=notifications@example.com
      - S3_ENABLED=false
      - WEB_DOMAIN=mastodon.example.com #optional
      - ES_HOST=es #optional
      - ES_PORT=9200 #optional
      - ES_USER=elastic #optional
      - ES_PASS=elastic #optional
      - S3_BUCKET= #optional
      - AWS_ACCESS_KEY_ID= #optional
      - AWS_SECRET_ACCESS_KEY= #optional
      - S3_ALIAS_HOST= #optional
      - WEB_CONCURRENCY=2 #optional
      - MAX_THREADS=5 #optional
    volumes:
      - /path/to/appdata/config:/config
    ports:
      - 80:80
      - 443:443
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=hometown \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=America/New_York \
  -e LOCAL_DOMAIN=example.com \
  -e REDIS_HOST=redis \
  -e REDIS_PORT=6379 \
  -e DB_HOST=db \
  -e DB_USER=mastodon \
  -e DB_NAME=mastodon \
  -e DB_PASS=mastodon \
  -e DB_PORT=5432 \
  -e ES_ENABLED=false \
  -e SECRET_KEY_BASE= \
  -e OTP_SECRET= \
  -e VAPID_PRIVATE_KEY= \
  -e VAPID_PUBLIC_KEY= \
  -e SMTP_SERVER=mail.example.com \
  -e SMTP_PORT=25 \
  -e SMTP_LOGIN= \
  -e SMTP_PASSWORD= \
  -e SMTP_FROM_ADDRESS=notifications@example.com \
  -e S3_ENABLED=false \
  -e WEB_DOMAIN=mastodon.example.com `#optional` \
  -e ES_HOST=es `#optional` \
  -e ES_PORT=9200 `#optional` \
  -e ES_USER=elastic `#optional` \
  -e ES_PASS=elastic `#optional` \
  -e S3_BUCKET= `#optional` \
  -e AWS_ACCESS_KEY_ID= `#optional` \
  -e AWS_SECRET_ACCESS_KEY= `#optional` \
  -e S3_ALIAS_HOST= `#optional` \
  -e WEB_CONCURRENCY=2 `#optional` \
  -e MAX_THREADS=5 `#optional` \
  -p 80:80 \
  -p 443:443 \
  -v /path/to/appdata/config:/config \
  --restart unless-stopped \
  dev.cat-enby.club/nikurasu/hometown:latest

Parameters

Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Parameter	Function
-p 80	Port for web frontend
-p 443	Port for web frontend
-e PUID=1000	for UserID - see below for explanation
-e PGID=1000	for GroupID - see below for explanation
-e TZ=America/New_York	Specify a timezone to use EG America/New_York
-e LOCAL_DOMAIN=example.com	This is the unique identifier of your server in the network. It cannot be safely changed later.
-e REDIS_HOST=redis	Redis server hostname
-e REDIS_PORT=6379	Redis port
-e DB_HOST=db	Postgres database hostname
-e DB_USER=mastodon	Postgres username
-e DB_NAME=mastodon	Postgres db name
-e DB_PASS=mastodon	Postgres password
-e DB_PORT=5432	Portgres port
-e ES_ENABLED=false	Enable or disable Elasticsearch (requires a separate ES instance)
-e SECRET_KEY_BASE=	Browser session secret. Changing it will break all active browser sessions.
-e OTP_SECRET=	MFA secret. Changing it will break two-factor authentication.
-e VAPID_PRIVATE_KEY=	Push notification private key. Changing it will break push notifications.
-e VAPID_PUBLIC_KEY=	Push notification public key. Changing it will break push notifications.
-e SMTP_SERVER=mail.example.com	SMTP server for email notifications
-e SMTP_PORT=25	SMTP server port
-e SMTP_LOGIN=	SMTP username
-e SMTP_PASSWORD=	SMTP password
-e SMTP_FROM_ADDRESS=notifications@example.com	From address for emails send from Mastodon
-e S3_ENABLED=false	Enable or disable S3 storage of uploaded files
-e WEB_DOMAIN=mastodon.example.com	This can be set if you want your server identifier to be different to the subdomain hosting Mastodon. See https://docs.joinmastodon.org/admin/config/#basic
-e ES_HOST=es	Elasticsearch server hostname
-e ES_PORT=9200	Elasticsearch port
-e ES_USER=elastic	Elasticsearch username
-e ES_PASS=elastic	Elasticsearch password
-e S3_BUCKET=	S3 bucket hostname
-e AWS_ACCESS_KEY_ID=	S3 bucket access key ID
-e AWS_SECRET_ACCESS_KEY=	S3 bucket secret access key
-e S3_ALIAS_HOST=	Alternate hostname for object fetching if you are front the S3 connections.
-e WEB_CONCURRENCY=2	Specific to Puma, this variable determines how many different processes Puma forks into. Defaults to 2.
-e MAX_THREADS=5	Specific to Puma, this variable determines how many threads each Puma process maintains. Defaults to 5.
-v /config	Contains all relevant configuration files.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Support Info

• Shell access whilst the container is running: docker exec -it hometown /bin/bash
• To monitor the logs of the container in realtime: docker logs -f hometown
• container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' hometown
• image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' dev.cat-enby.club/nikurasu/hometown:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull hometown
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d hometown
• You can also remove the old dangling images: docker image prune

Via Docker Run

• Update the image: docker pull dev.cat-enby.club/nikurasu/hometown:latest
• Stop the running container: docker stop hometown
• Delete the container: docker rm hometown
• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• You can also remove the old dangling images: docker image prune

Via Watchtower auto-updater (only use if you don't remember the original parameters)

• Pull the latest image at its tag and replace it with the same env variables in one run:

  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once hometown
  

• You can also remove the old dangling images: docker image prune

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

Image Update Notifications - Diun (Docker Image Update Notifier)

• We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://dev.cat-enby.club/nikurasu/docker-hometown.git
cd docker-hometown
docker build \
  --no-cache \
  --pull \
  -t dev.cat-enby.club/nikurasu/hometown:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

• 05.11.22: - Initial Release.