Skip to content

Commit fbe92c2

Browse files
committed
Update readme.
1 parent cfd4985 commit fbe92c2

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@ OpenCTF // Filestore
33

44
This is a static file server, responsible for serving not only web assets, but also user avatars and challenge-related files (autogen included). It runs a Flask app on port 8000, listening internally from the main web application for uploads, and then serves the files using an Nginx server that is proxied from the main server.
55

6+
To run Filestore, just run `app.py` with Python 3. It will start the Filestore server on port 7910. If you are debugging OpenCTF locally without Nginx, you can also use `/static/<path>` to retrieve saved files.
7+
8+
Options
9+
-------
10+
11+
If you want, you can modify Filestore's behavior by setting the following environment variables:
12+
13+
* **FILESTORE_PORT** (defaults to 7910). Provide an integer port that the Flask server will listen on. The application will fail if your user does not have permission to use the port specified or if the port is in use.
14+
* **UPLOAD_FOLDER** (defaults to `/usr/share/nginx/html`). Provide the path to a writeable folder that the server will save to. Ideally, the Nginx should be able to fetch directly from this directory.
15+
616

717
Contact
818
-------

0 commit comments

Comments
 (0)