{"id":19680602,"url":"https://github.com/rojenzaman/amusewiki-docker","last_synced_at":"2025-04-29T04:31:33.427Z","repository":{"id":43833927,"uuid":"474901755","full_name":"rojenzaman/amusewiki-docker","owner":"rojenzaman","description":"Production-ready docker images for AmuseWiki.","archived":false,"fork":false,"pushed_at":"2025-03-16T00:37:53.000Z","size":235,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-05T13:05:50.101Z","etag":null,"topics":["amusewiki","docker","docker-compose","library","library-management-system","podman","podman-compose","wiki"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/rojen/amusewiki","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"cohosh/amusewiki-docker","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rojenzaman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-28T07:57:45.000Z","updated_at":"2025-03-16T00:37:56.000Z","dependencies_parsed_at":"2023-01-25T21:46:11.562Z","dependency_job_id":"fccfdf77-92be-4f85-abf5-53e7c570e407","html_url":"https://github.com/rojenzaman/amusewiki-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rojenzaman%2Famusewiki-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rojenzaman%2Famusewiki-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rojenzaman%2Famusewiki-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rojenzaman%2Famusewiki-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rojenzaman","download_url":"https://codeload.github.com/rojenzaman/amusewiki-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251432832,"owners_count":21588664,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amusewiki","docker","docker-compose","library","library-management-system","podman","podman-compose","wiki"],"created_at":"2024-11-11T18:05:32.596Z","updated_at":"2025-04-29T04:31:33.421Z","avatar_url":"https://github.com/rojenzaman.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Amusewiki Docker\n\n[![](https://img.shields.io/docker/image-size/rojen/amusewiki/latest)](https://hub.docker.com/r/rojen/amusewiki) [![](https://img.shields.io/docker/image-size/rojen/amusewiki/texlive-minimal)](https://hub.docker.com/r/rojen/amusewiki) [![rojen/amusewiki:package](https://github.com/rojenzaman/amusewiki-docker/actions/workflows/package.yml/badge.svg)](https://github.com/rojenzaman/amusewiki-docker/actions/workflows/package.yml) [![rojen/amusewiki:texlive-minimal](https://github.com/rojenzaman/amusewiki-docker/actions/workflows/texlive-minimal.yml/badge.svg)](https://github.com/rojenzaman/amusewiki-docker/actions/workflows/texlive-minimal.yml) [![rojen/amusewiki:texlive-base](https://github.com/rojenzaman/amusewiki-docker/actions/workflows/texlive-base.yml/badge.svg)](https://github.com/rojenzaman/amusewiki-docker/actions/workflows/texlive-base.yml) [![rojen/amusewiki:texlive-full](https://github.com/rojenzaman/amusewiki-docker/actions/workflows/texlive-full.yml/badge.svg)](https://github.com/rojenzaman/amusewiki-docker/actions/workflows/texlive-full.yml) [![](https://img.shields.io/docker/pulls/rojen/amusewiki)](https://hub.docker.com/r/rojen/amusewiki)\n\n\u003c!--\nhttps://badgen.net/docker/layers/rojen/amusewiki/latest/amd64?icon=docker\u0026label=layers\n--\u003e\n\n### Quickly deploy a demo on [Play With Docker](_testing/pwd)\n\n[![Try in PWD](https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/rojenzaman/amusewiki-docker/master/_testing/pwd/package.yml\u0026stack_name=amusewiki)\n\nClick the button above then click **start**, wait for it to deploy. Then click **80**.\n\n - The default username is: `amusewiki`\n - The default password is: `changeme`\n\n### Tags\n\n - [`package, latest, package-2.551, package-2.560, package-2.561, package-2.562, package-2.563, package-2.565, package-2.566, package-2.571, package-2.572, package-2.574, package-2.575, package-2.576, package-2.577, package-2.578, package-2.579, package-2.580, package-2.581, package-2.582, package-2.583, package-2.590, package-2.593, package-2.594, package-2.596, package-2.597, package-2.598, package-2.599, package-2.600, package-2.601, package-2.602, package-2.603, package-2.605`](https://github.com/rojenzaman/amusewiki-docker/blob/master/package/Dockerfile)\n - [`texlive-minimal, texlive-minimal-2.593, texlive-minimal-2.594, texlive-minimal-2.596, texlive-minimal-2.597, texlive-minimal-2.598, texlive-minimal-2.599, texlive-minimal-2.600, texlive-minimal-2.601, texlive-minimal-2.602, texlive-minimal-2.603, texlive-minimal-2.605`](https://github.com/rojenzaman/amusewiki-docker/blob/master/texlive-minimal/Dockerfile)\n - [`texlive-base`](https://github.com/rojenzaman/amusewiki-docker/blob/master/texlive-base/Dockerfile)\n - [`texlive-full`](https://github.com/rojenzaman/amusewiki-docker/blob/master/texlive-full/Dockerfile)\n\n### Environment Variables\n\n| Name | Required | Description\n|---|---|---\n| `POST_DOMAIN` | No | \u003ca id=\"POST_DOMAIN\"\u003e\u003c/a\u003eChange initial or selected domain\n| `CHANGE_DOMAIN_BY_ID` | No | \u003ca id=\"\"\u003e\u003c/a\u003eDefault is initial domain: `1`\n| `CONTAINER_IS_BEHIND_HTTPS_TRAEFIK` | No | \u003ca id=\"CHANGE_DOMAIN_BY_ID\"\u003e\u003c/a\u003eSetting this to `true` will enable HTTPS Traefik support\n| `AMW_WORKERS` | No | \u003ca id=\"AMW_WORKERS\"\u003e\u003c/a\u003eSpecify number of process set by script/init-fcgi.pl\n| `AMW_NPROC` | No | \u003ca id=\"\"\u003e\u003c/a\u003eSpecify number of perl-fcgi process\n| `CHANGE_PASSWORD_BEFORE_RUN` | No | \u003ca id=\"AMW_NPROC\"\u003e\u003c/a\u003eSetting this to `true` will enable password changing\n| `AMW_USERNAME` | No | \u003ca id=\"AMW_USERNAME\"\u003e\u003c/a\u003eSet username\n| `AMW_PASSWORD` | No | \u003ca id=\"AMW_PASSWORD\"\u003e\u003c/a\u003eSet password\n| `HOST_SSH_PUBLIC_KEY` | No | \u003ca id=\"HOST_SSH_PUBLIC_KEY\"\u003e\u003c/a\u003eAuthorize host ssh public key\n| `GENERATE_NEW_SSH_KEY` | No | \u003ca id=\"GENERATE_NEW_SSH_KEY\"\u003e\u003c/a\u003eSetting thist to `true` will crate new ssh key\n| `NGX_PREFIX` | No | \u003ca id=\"NGX_PREFIX\"\u003e\u003c/a\u003e`amusewikidebian` or `amusewiki`\n| `AMUSEWIKI_SWITCH_BRANCH` | No | \u003ca id=\"AMUSEWIKI_SWITCH_BRANCH\"\u003e\u003c/a\u003eSwitch to given branch before run (*texlive-minimal*, *texlive-base*, *texlive-full*)\n| `CREATE_MISSING_STAGING_FILES` | No | \u003ca id=\"CREATE_MISSING_STAGING_FILES\"\u003e\u003c/a\u003eSetting this to `true` will create missing staging files\n| `AMW_SQLITE_PATH` | No | \u003ca id=\"AMW_SQLITE_PATH\"\u003e\u003c/a\u003eDefault is `/var/lib/dbconfig-common/sqlite3/amusewiki/amusewiki`\n| `UPDATE_AMUSEWIKI` | No | \u003ca id=\"UPDATE_AMUSEWIKI\"\u003e\u003c/a\u003eSetting this to `true` will update/pull amusewiki before start\n| `OTHER_VOLUMES_USED_IN_CONTAINER` | No | \u003ca id=\"OTHER_VOLUMES_USED_IN_CONTAINER\"\u003e\u003c/a\u003eSet the container path of your custom volumes. Commands like chown, backup_amw.sh will detect these objects. Example: `/var/lib/amusewiki/log, /var/lib/amusewiki/ssl, /var/lib/amusewiki/.ssh`\n| `EMAIL_SENDER_TRANSPORT` | No | \u003ca id=\"EMAIL_SENDER_TRANSPORT\"\u003e\u003c/a\u003eSet it to `SMTP`\n| `EMAIL_SENDER_TRANSPORT_ssl` | No | \u003ca id=\"EMAIL_SENDER_TRANSPORT_ssl\"\u003e\u003c/a\u003eRequired for most email providers, set it to `1`\n| `EMAIL_SENDER_TRANSPORT_host` | No | \u003ca id=\"EMAIL_SENDER_TRANSPORT_host\"\u003e\u003c/a\u003ee.g. for Riseup `mail.riseup.net`\n| `EMAIL_SENDER_TRANSPORT_port` | No | \u003ca id=\"EMAIL_SENDER_TRANSPORT_port\"\u003e\u003c/a\u003ee.g. for Riseup `465`\n| `EMAIL_SENDER_TRANSPORT_sasl_username` | No | \u003ca id=\"EMAIL_SENDER_TRANSPORT_sasl_username\"\u003e\u003c/a\u003ee.g. for Riseup `yourname@riseup.net`\n| `EMAIL_SENDER_TRANSPORT_sasl_password` | No | \u003ca id=\"EMAIL_SENDER_TRANSPORT_sasl_password\"\u003e\u003c/a\u003ee.g. for Riseup `yourpass`\n\n### Volumes\n\nRequired volumes:\n\n - `/var/lib/amusewiki/repo`  **git**\n - `/var/lib/amusewiki/thumbnails`  **thumb**\n - `/var/lib/amusewiki/staging` **staging**\n - `/var/lib/dbconfig-common/sqlite3/amusewiki` **db**\n - `/etc/nginx/sites-enabled` **web**\n\nOptional volumes: (*set [OTHER_VOLUMES_USED_IN_CONTAINER](#OTHER_VOLUMES_USED_IN_CONTAINER) to use them*)\n\n - `/var/lib/amusewiki/log` **log**\n - `/var/lib/amusewiki/ssl` **ssl**\n - `/var/lib/amusewiki/.ssh` **ssh**\n\n### Quick docker-compose.yml\n\n```yaml\nservices:\n  app:\n    image: rojen/amusewiki:package\n    ports:\n      - '80:80'\n      - '443:443'\n    environment:\n      - POST_DOMAIN=localhost\n      - CHANGE_PASSWORD_BEFORE_RUN=true\n      - AMW_USERNAME=amusewiki\n      - AMW_PASSWORD=changeme\n    volumes:\n      - repo:/var/lib/amusewiki/repo\n      - thumb:/var/lib/amusewiki/thumbnails\n      - staging:/var/lib/amusewiki/staging\n      - db:/var/lib/dbconfig-common/sqlite3/amusewiki\n      - web:/etc/nginx/sites-enabled\nvolumes:\n  repo:\n  thumb:\n  staging:\n  db:\n  web:\n```\n\n### Be careful!\n\nThis repo use SQLite as a database. Currently MySQL and PostgreSQL are not supported. See: [TODO](https://github.com/rojenzaman/amusewiki-docker/blob/master/TODO.md)\n\nThis image is production ready! Beleive it or not.\n\n### How to use?\n\nRead the usage notes and check the example **docker-compose.yml** files: [amusewiki-docker/wiki](https://github.com/rojenzaman/amusewiki-docker/wiki)\n\n### Related Projects\n\n - [coop-cloud/amusewiki](https://git.coopcloud.tech/coop-cloud/amusewiki): Run amusewiki on [Co-op Cloud](https://docs.coopcloud.tech) with HTTPS Traefik.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frojenzaman%2Famusewiki-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frojenzaman%2Famusewiki-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frojenzaman%2Famusewiki-docker/lists"}