diff --git a/README.md b/README.md index eef39b7..bf1f06d 100644 --- a/README.md +++ b/README.md @@ -57,12 +57,23 @@ The architectures supported by this image are: | arm64 | ✅ | arm64v8-\ | | 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 lscr.io/linuxserver/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 lscr.io/linuxserver/mastodon mastodon:webpush:generate_vapid_key` +To use `tootctl` you can run something like `docker exec -it -w /app/www mastodon bin/tootctl ` + This container *requires* separate postgres and redis instances to run. We support all of the official [environment variables](https://docs.joinmastodon.org/admin/config) for configuration. In place of adding them all to your run/compose you can use an env file such as [this example](https://github.com/mastodon/mastodon/blob/main/.env.production.sample) from the upstream project. diff --git a/readme-vars.yml b/readme-vars.yml index edd4167..c8f52bc 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -14,6 +14,12 @@ available_architectures: - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"} - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} +# development version +development_versions: true +development_versions_items: + - { tag: "latest", desc: "Stable releases." } + - { tag: "develop", desc: "Pre-releases *only*." } + # container parameters common_param_env_vars_enabled: true param_container_name: "{{ project_name }}" @@ -69,6 +75,8 @@ app_setup_block: | To generate keys for `VAPID_PRIVATE_KEY` & `VAPID_PUBLIC_KEY` run `docker run --rm -it -w /app/www --entrypoint rake lscr.io/linuxserver/mastodon mastodon:webpush:generate_vapid_key` + To use `tootctl` you can run something like `docker exec -it -w /app/www mastodon bin/tootctl ` + This container *requires* separate postgres and redis instances to run. We support all of the official [environment variables](https://docs.joinmastodon.org/admin/config) for configuration. In place of adding them all to your run/compose you can use an env file such as [this example](https://github.com/mastodon/mastodon/blob/main/.env.production.sample) from the upstream project.