noury/mirror-yaf
1
0
Fork 0
mirror of https://github.com/lyx0/yaf.git synced 2024-11-13 19:49:53 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add port publishing with some documentation

Browse source
This commit is contained in:
Rasmus Karlsson 2022-08-13 21:39:09 +02:00
parent ae33975668
commit 5cec67bfdb
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -58,6 +58,7 @@ Of course, you can also write a init system script to handle this for you.
Running it from the GitHub Container Registry Running it from the GitHub Container Registry
```bash ```bash
docker run \ docker run \
-p 4712:4711 \
-v /path/to/your/config.conf:/app/jaf.conf \ -v /path/to/your/config.conf:/app/jaf.conf \
-v /path/to/where/you/want/your/files/to/be/stored:/FileDir/in/your/config \ -v /path/to/where/you/want/your/files/to/be/stored:/FileDir/in/your/config \
ghcr.io/leon-richardt/jaf:latest ghcr.io/leon-richardt/jaf:latest
@ -67,11 +68,15 @@ Building the Docker image and running it locally
```bash ```bash
docker build -t jaf . docker build -t jaf .
docker run \ docker run \
-p 4712:4711 \
-v /path/to/your/config.conf:/app/jaf.conf \ -v /path/to/your/config.conf:/app/jaf.conf \
-v /path/to/where/you/want/your/files/to/be/stored:/FileDir/in/your/config \ -v /path/to/where/you/want/your/files/to/be/stored:/FileDir/in/your/config \
jaf jaf
``` ```
Port 4711 is the default port for the server in `example.conf`, if you've changed this in your config you'll need to change this in the `docker run` invocations above too.
The above runs forwards the jaf port from 4711 in the container to 4712 on your local system.
## Usage ## Usage
You can use jaf with any application that can send POST requests (e.g. ShareX/ShareNix or just `curl`). You can use jaf with any application that can send POST requests (e.g. ShareX/ShareNix or just `curl`).
Make sure the file you want to upload is attached as a `multipart/form-data` field named `file`. Make sure the file you want to upload is attached as a `multipart/form-data` field named `file`.