Skip to content

Commit 9785fe9

Browse files
committed
Added docs for docker compose services
1 parent dc7d214 commit 9785fe9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

simpleclient/docker/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Docker services for server and web client
2+
3+
For convenience, all services required for running the F-UJI server and a simple web client have been bundled up in [`compose.yml`](./compose.yml):
4+
- `fuji-server` runs the API server
5+
- `nginx` and `php` provide the web interface
6+
7+
To start, make sure you have Docker installed on your system (refer to the [official documentation](https://docs.docker.com/engine/install/) for details).
8+
9+
## Configuration
10+
11+
Open [`fuji/fuji_server/config/users.py`](../../fuji_server/config/users.py) and set a username and password.
12+
Set the same username and password in [`index.php`](./index.php#L51) in the variables `$fuji_username` and `$fuji_password`.
13+
14+
Optionally, follow the instructions in the [root README](../../README.md#github-api) to set up authorisation with GitHub.
15+
16+
## Build
17+
18+
Next, build the API server image.
19+
Navigate to the root of this repository and run `docker build -t fuji-ext .`.
20+
This should use the [`Dockerfile`](../../Dockerfile) at the root of the repository.
21+
22+
With that done, navigate back to this directory (`fuji/simpleclient/docker`) and run `docker compose up -d`.
23+
The web client will be available on `localhost:80`.

0 commit comments

Comments
 (0)