File tree Expand file tree Collapse file tree 3 files changed +11
-38
lines changed Expand file tree Collapse file tree 3 files changed +11
-38
lines changed Original file line number Diff line number Diff line change @@ -12,25 +12,25 @@ CTFNote is a collaborative tool aiming to help CTF teams to organise their work.
1212
1313Before starting, make sure to fill in the information in the ` .env `  file.
1414
15- ### Pre-build images  
15+ ### Running the Docker containers  
16+ 
17+ You can build and start CTFNote with ` docker compose ` . The default
18+ configuration makes it super easy to start a new instance!
1619
1720Building CTFNote requires at least 3 GB of RAM. If you want to host CTFNote
1821on a server with less than 3 GB of RAM, you can use the pre-build images
1922from the GitHub Container Registry.
2023
21- Download  ` docker-compose.yml `  and  ` docker-compose.prebuild. yml `  for example through cloning the repository and run:
24+ To use the pre-build images, download  ` docker-compose.yml `  ( for example through cloning the repository)  and run:
2225
2326``` shell 
24- $ docker compose -f docker-compose.prebuild.yml  up -d --pull always
27+ $ docker compose up -d --pull always
2528``` 
2629
27- ### Self-build images  
28- 
29- You can build and start CTFNote with ` docker compose ` . The default
30- configuration makes it super easy to start a new instance!
30+ To self-build the images, clone the repository and run:
3131
3232``` shell 
33- $ docker compose up -d
33+ $ docker compose up -d --build 
3434``` 
3535
3636### Accessing the instance  
  Load Diff This file was deleted. 
Original file line number Diff line number Diff line change 11version : " 3.7" 
22services :
33  api :
4+     image : ghcr.io/tfns/ctfnote/api:latest 
45    build :
56      context : " ./api" 
67    networks :
@@ -22,6 +23,7 @@ services:
2223    volumes :
2324      - ctfnote-uploads:/app/uploads 
2425  db :
26+     image : ghcr.io/tfns/ctfnote/db:latest 
2527    build :
2628      context : " ./db" 
2729    restart : always 
@@ -34,6 +36,7 @@ services:
3436    networks :
3537      - ctfnote 
3638  front :
39+     image : ghcr.io/tfns/ctfnote/front:latest 
3740    networks :
3841      - ctfnote 
3942    restart : always 
    
 
   
 
     
   
   
          
     
  
    
     
 
    
      
     
 
     
    You can’t perform that action at this time.
  
 
    
  
     
    
      
        
     
 
       
      
     
   
 
    
    
  
 
  
 
     
    
0 commit comments