Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rojenzaman/amusewiki-docker

Production-ready docker images for AmuseWiki.
https://github.com/rojenzaman/amusewiki-docker

amusewiki docker docker-compose library library-management-system podman podman-compose wiki

Last synced: 2 days ago
JSON representation

Production-ready docker images for AmuseWiki.

Host: GitHub
URL: https://github.com/rojenzaman/amusewiki-docker
Owner: rojenzaman
License: mit
Created: 2022-03-28T07:57:45.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-11-07T19:51:32.000Z (6 days ago)
Last Synced: 2024-11-07T20:38:28.860Z (6 days ago)
Topics: amusewiki, docker, docker-compose, library, library-management-system, podman, podman-compose, wiki
Language: Shell
Homepage: https://hub.docker.com/r/rojen/amusewiki
Size: 208 KB
Stars: 13
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ## Amusewiki Docker

[![](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)

### Quickly deploy a demo on [Play With Docker](_testing/pwd)

[![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&stack_name=amusewiki)

Click the button above then click **start**, wait for it to deploy. Then click **80**.

 - The default username is: `amusewiki`

 - The default password is: `changeme`

### Tags

 - [`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`](https://github.com/rojenzaman/amusewiki-docker/blob/master/package/Dockerfile)

 - [`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`](https://github.com/rojenzaman/amusewiki-docker/blob/master/texlive-minimal/Dockerfile)

 - [`texlive-base`](https://github.com/rojenzaman/amusewiki-docker/blob/master/texlive-base/Dockerfile)

 - [`texlive-full`](https://github.com/rojenzaman/amusewiki-docker/blob/master/texlive-full/Dockerfile)

### Environment Variables

| Name | Required | Description

|---|---|---

| `POST_DOMAIN` | No | Change initial or selected domain

| `CHANGE_DOMAIN_BY_ID` | No | Default is initial domain: `1`

| `CONTAINER_IS_BEHIND_HTTPS_TRAEFIK` | No | Setting this to `true` will enable HTTPS Traefik support

| `AMW_WORKERS` | No | Specify number of process set by script/init-fcgi.pl

| `AMW_NPROC` | No | Specify number of perl-fcgi process

| `CHANGE_PASSWORD_BEFORE_RUN` | No | Setting this to `true` will enable password changing

| `AMW_USERNAME` | No | Set username

| `AMW_PASSWORD` | No | Set password

| `HOST_SSH_PUBLIC_KEY` | No | Authorize host ssh public key

| `GENERATE_NEW_SSH_KEY` | No | Setting thist to `true` will crate new ssh key

| `NGX_PREFIX` | No | `amusewikidebian` or `amusewiki`

| `AMUSEWIKI_SWITCH_BRANCH` | No | Switch to given branch before run (*texlive-minimal*, *texlive-base*, *texlive-full*)

| `CREATE_MISSING_STAGING_FILES` | No | Setting this to `true` will create missing staging files

| `AMW_SQLITE_PATH` | No | Default is `/var/lib/dbconfig-common/sqlite3/amusewiki/amusewiki`

| `UPDATE_AMUSEWIKI` | No | Setting this to `true` will update/pull amusewiki before start

| `OTHER_VOLUMES_USED_IN_CONTAINER` | No | Set 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`

| `EMAIL_SENDER_TRANSPORT` | No | Set it to `SMTP`

| `EMAIL_SENDER_TRANSPORT_ssl` | No | Required for most email providers, set it to `1`

| `EMAIL_SENDER_TRANSPORT_host` | No | e.g. for Riseup `mail.riseup.net`

| `EMAIL_SENDER_TRANSPORT_port` | No | e.g. for Riseup `465`

| `EMAIL_SENDER_TRANSPORT_sasl_username` | No | e.g. for Riseup `[email protected]`

| `EMAIL_SENDER_TRANSPORT_sasl_password` | No | e.g. for Riseup `yourpass`

### Volumes

Required volumes:

 - `/var/lib/amusewiki/repo`  **git**

 - `/var/lib/amusewiki/thumbnails`  **thumb**

 - `/var/lib/amusewiki/staging` **staging**

 - `/var/lib/dbconfig-common/sqlite3/amusewiki` **db**

 - `/etc/nginx/sites-enabled` **web**

Optional volumes: (*set [OTHER_VOLUMES_USED_IN_CONTAINER](#OTHER_VOLUMES_USED_IN_CONTAINER) to use them*)

 - `/var/lib/amusewiki/log` **log**

 - `/var/lib/amusewiki/ssl` **ssl**

 - `/var/lib/amusewiki/.ssh` **ssh**

### Quick docker-compose.yml

```yaml

version: '3.4'

services:

  app:

    image: rojen/amusewiki:package

    ports:

      - '80:80'

      - '443:443'

    environment:

      - POST_DOMAIN=localhost

      - CHANGE_PASSWORD_BEFORE_RUN=true

      - AMW_USERNAME=amusewiki

      - AMW_PASSWORD=changeme

    volumes:

      - repo:/var/lib/amusewiki/repo

      - thumb:/var/lib/amusewiki/thumbnails

      - staging:/var/lib/amusewiki/staging

      - db:/var/lib/dbconfig-common/sqlite3/amusewiki

      - web:/etc/nginx/sites-enabled

volumes:

  repo:

  thumb:

  staging:

  db:

  web:

```

### Be careful!

This 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)

This image is production ready! Beleive it or not.

### How to use?

Read the usage notes and check the example **docker-compose.yml** files: [amusewiki-docker/wiki](https://github.com/rojenzaman/amusewiki-docker/wiki)

### Related Projects

 - [coop-cloud/amusewiki](https://git.coopcloud.tech/coop-cloud/amusewiki): Run amusewiki on [Co-op Cloud](https://docs.coopcloud.tech) with HTTPS Traefik.