/docker-fiduswriter

Docker image for fiduswriter collaborative writing tool

Primary LanguageShellGNU Affero General Public License v3.0AGPL-3.0

docker-fiduswriter

automated build pulls

FidusWriter is a collaborative online writing tool. This is a docker image that was built following the official installation manual for Ubuntu as closely as possible.

Builds and Tags on DockerHub

Builds on Docker are tagged following this pattern and are triggered automatically through changes in this project (moritzfl/docker-fiduswriter) ("develop" ist triggered by commits, the others through releases):

  • latest: latest release or prerelease of fiduswriter (most current "release-[VERSION]" or "prerelease-[VERSION]")

  • latest-stable: version representing the latest stable release of fiduswriter (most current "release-[VERSION]")

  • release-[VERSION]: a stable release of fiduswriter (equivalent to "release" on fiduswriter-repo)

  • prerelease-[VERSION]: a potentially unstable version of fiduswriter (equivalent to "prerelease" on fiduswriter-repo)

  • develop: a development build is done after each commit

How to use this image

You will need to modify the entries for ALLOWED_HOSTS in the file /data/configuration.py in order to allow access from any URL other than localhost. I would recommend mapping the data directory to a directory on your host machine for data persistence and easy configuration (follow the instrucions below).

Until you define a mail-server (also through /data/configuration.py), the mails and contained links required for user registration get printed to the outputstream of the container.

In order to persist data, you must grant write access for the executing user (fiduswriter) to the data directory that you want to map to on the host. This can be achieved by issuing the command below. If you do not ensure access to the desired directory on the host, fiduswriter will not run correctly.

$ sudo chown -R 999:999 /host/directory

(Replace "/host/directory" with a valid directory on your host machine)

To get fiduswriter running use (you can do without -v /host/directory:/data but that means no persistent data):

$ docker run -d -v /host/directory:/data -p 8000:8000 --name moritzf-fiduswriter moritzf/fiduswriter:latest

(Replace "/host/directory" with a valid directory on your host machine)

If needed, you can create an administrative account for fiduswriter by attaching the container to your terminal and issuing the following command:

$ python3 manage.py createsuperuser