Skip to content

Commit e131f00

Browse files
Koenraad VerheydenJoshua Nelson
authored andcommitted
Document services defined by docker-compose.yml
1 parent 65fc2d7 commit e131f00

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,17 @@ information on how to setup this environment.
9696

9797
### Docker-Compose
9898

99+
The services started by Docker-Compose are defined in [docker-compose.yml].
100+
Three services are defined:
101+
102+
| name | access | credentials | description |
103+
|------|-----------------------|----------------------------|----------------------------------------|
104+
| web | http://localhost:3000 | N/A | A container running the docs.rs binary |
105+
| db | / | N/A | Postgres database used by web |
106+
| s3 | http://localhost:9000 | `cratesfyi` - `secret_key` | Minio (simulates AWS S3) used by web |
107+
108+
[docker-compose.yml]: ./docker-compose.yml
109+
99110
#### Rebuilding Containers
100111

101112
To rebuild the site, run `docker-compose build`.

0 commit comments

Comments
 (0)