Skip to content

Commit

Permalink
Merge pull request #232 from erdnaxe/0-simplify-compose
Browse files Browse the repository at this point in the history
Merge docker-compose.prebuild.yml into docker-compose.yml
  • Loading branch information
XeR authored Feb 20, 2024
2 parents b58f2b7 + 9917328 commit 5cda0e7
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 38 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,25 @@ CTFNote is a collaborative tool aiming to help CTF teams to organise their work.

Before starting, make sure to fill in the information in the `.env` file.

### Pre-build images
### Running the Docker containers

You can build and start CTFNote with `docker compose`. The default
configuration makes it super easy to start a new instance!

Building CTFNote requires at least 3 GB of RAM. If you want to host CTFNote
on a server with less than 3 GB of RAM, you can use the pre-build images
from the GitHub Container Registry.

Download `docker-compose.yml` and `docker-compose.prebuild.yml` for example through cloning the repository and run:
To use the pre-build images, download `docker-compose.yml` (for example through cloning the repository) and run:

```shell
$ docker compose -f docker-compose.prebuild.yml up -d --pull always
$ docker compose up -d --pull always
```

### Self-build images

You can build and start CTFNote with `docker compose`. The default
configuration makes it super easy to start a new instance!
To self-build the images, clone the repository and run:

```shell
$ docker compose up -d
$ docker compose up -d --build
```

### Accessing the instance
Expand Down
30 changes: 0 additions & 30 deletions docker-compose.prebuild.yml

This file was deleted.

3 changes: 3 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
version: "3.7"
services:
api:
image: ghcr.io/tfns/ctfnote/api:latest
build:
context: "./api"
networks:
Expand All @@ -22,6 +23,7 @@ services:
volumes:
- ctfnote-uploads:/app/uploads
db:
image: ghcr.io/tfns/ctfnote/db:latest
build:
context: "./db"
restart: always
Expand All @@ -34,6 +36,7 @@ services:
networks:
- ctfnote
front:
image: ghcr.io/tfns/ctfnote/front:latest
networks:
- ctfnote
restart: always
Expand Down

0 comments on commit 5cda0e7

Please sign in to comment.