Skip to content

Commit 1289fae

Browse files
authored
chore: add more documentation on how to configure the docker image
1 parent 418ce70 commit 1289fae

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,34 @@ It is responsible for building static assets but not for running a web server li
7979
- The outputs of the builds are written to `/var/www/html/` base directory on the container.
8080
- Runs a command when the container starts that builds the visualizer admin page to the `on-tabs` directory, based on the `/on-tabs-config.json` configuration file.
8181
- Runs a command every minute which builds pages to the base directory based on the `/flavor-config.json` configuration file.
82+
83+
## Configuring the docker image
84+
85+
Example of configuration with some hints:
86+
87+
```yml
88+
services:
89+
flavor-builder:
90+
# Replace with a fixed version
91+
image: ghcr.io/cheminfo/flavor-builder:latest
92+
# Wrap with a process which handles SIGTERM signals.
93+
init: true
94+
environment:
95+
DEBUG: 'flavor-builder:info'
96+
COUCHDB_USER: admin
97+
COUCHDB_PASSWORD: ${COUCHDB_ADMIN_PASSWORD}
98+
volumes:
99+
# Used to build static pages periodically.
100+
- ./config/flavor-builder-config.json:/flavor-config.json:ro
101+
# Used to build the /on-tabs/ page.
102+
- ./config/on-tabs-config.json:/on-tabs-config.json:ro
103+
# Output directory, usually needed so that another service can serve the built files.
104+
- ./www:/var/www/html
105+
depends_on:
106+
# Recommended to prevent the build from failing if couchdb is not ready.
107+
- couchdb
108+
```
109+
110+
111+
112+

0 commit comments

Comments
 (0)