mirror of
https://gitlab.archlinux.org/archlinux/aurweb.git
synced 2025-02-03 10:43:03 +01:00
docs(docker): basic usage instructions
This commit is contained in:
parent
1e31db47ab
commit
7c36379715
1 changed files with 39 additions and 0 deletions
39
docker/README.md
Normal file
39
docker/README.md
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
# Aurweb and Docker
|
||||||
|
|
||||||
|
The `INSTALL` document details a manual Aurweb setup, but Docker images are also
|
||||||
|
provided here to avoid the complications of database configuration (and so
|
||||||
|
forth).
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
Naturally, both `docker` and `docker-compose` must be installed, and your Docker
|
||||||
|
service must be started:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
systemctl start docker.service
|
||||||
|
```
|
||||||
|
|
||||||
|
The main image - `aurweb` - must be built manually:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker compose build aurweb-image
|
||||||
|
```
|
||||||
|
|
||||||
|
### Starting and Stopping the Services
|
||||||
|
|
||||||
|
With the above steps complete, you can bring up an initial cluster:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker compose up
|
||||||
|
```
|
||||||
|
|
||||||
|
Subsequent runs will be done with `start` instead of `up`. The cluster can be
|
||||||
|
stopped with `docker compose stop`.
|
||||||
|
|
||||||
|
### Testing
|
||||||
|
|
||||||
|
With a running cluster, execute the following in a new terminal:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker compose run test
|
||||||
|
```
|
Loading…
Add table
Reference in a new issue