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.
| This project is the official Fidus Writer images and it's the continuation of the great work done by Moritz at https://github.com/moritzfl/docker-fiduswriter. Check his repository if you need older images. |
|---|
Builds on Docker are tagged following this pattern and are triggered automatically through changes in this project (fiduswriter/fiduswriter):
- latest: latest release or prerelease of fiduswriter (ie: fiduswriter/fiduswriter:latest).
- [MAJOR]: the lastest MAJOR release of fiduswriter (ie: fiduswriter/fiduswriter:3) of the version indicated.
- [MAJOR.minor]: the lastest MAJOR.minor release of fiduswriter (ie: fiduswriter/fiduswriter:3.11) of the version indicated.
- [MAJOR.minor.release]: a fixed version of fiduswriter (ie: fiduswriter/fiduswriter:3.11.9).
Fixed versions are recommended for production sites.
Easiest and fastest way is using docker-compose as follows:
$ sudo chown -R 999:999 ./volumes
$ docker-compose up -d
$ docker-compose exec fiduswriter fiduswriter createsuperuser
$ docker-compose logs
# Visit https://localhost:8000
In order to allow access from any URL other than localhost you will need to modify the entries for ALLOWED_HOSTS in the file /data/configuration.py. This file will let you define the domainname where your fiduswriter is running, your admin's mail and may other important settings. To keep this file persistent in an easy way, we recommend mapping the data directory to a directory on your host machine for data persistence.
In order to persist your data and configuration, you must grant write access for the executing user (fiduswriter) to the volumes 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 ./volumes
(Replace "./volumes" with the directory on your preference in your host machine)
If you like you can run fiduswriter without docker-compose, just with a docker run call (you can do without -v ./volumes/data:/data but that means data won't be persistent):
$ docker run -d -v ./volumes/data:/data -p 8000:8000 --name fiduswriter-fiduswriter fiduswriter/fiduswriter:latest
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
Notice that until you define a mail-server (also through /data/configuration.py), you won't be able to complete user's mail validation, but the mails and contained links required for user registration will be printed to the outputstream of the container.
Former explanation talks about docker, but for a fast an easy setting and running we recommend docker-compose.yml. This repository includes a docker-compose.yml file that describes a production like environment that uses a PostgreSQL database. You can retrieve dependencies, create volumes and generate the Dockerimage for Fidus Writer you only need to run:
$ docker-compose up
Add "-d" if you want it to run detached.
This will install all build-time dependencies into the image but, to configure it for the resulting container, we need to put some configuration in place. One last adaptation is needed after the initial run, since else the registration emails will be sent from example.com.
Once started, to create a super user account you only need to run:
$ docker-compose exec fiduswriter fiduswriter createsuperuser
and then login to /admin to change the site configuration. The default Django site that is created during fiduswriter setup is called example.com, which will be used by django-allauth for email messages. You will probably like to change this to a production value.
This application state needs to be adapted in /admin/sites/site/, which is only accessible to superusers, why we created the admin account just before.
Change the domain name to from where your instance can be reached, and the display name to indicate how you want it to be called. Then your Fidus Writer deployment should be complete.
Please leave comments in the issues if you have any remarks.