foomo/contentserver
1
0
Fork 0
mirror of https://github.com/foomo/contentserver.git synced 2025-10-16 12:25:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
Kevin Franklin Kim 2025-05-16 16:30:57 +02:00
parent 73203b24c0
commit 924bc01c07
No known key found for this signature in database
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -64,28 +64,29 @@ every other framework and language, too.
```bash ```bash
$ contentserver -h $ contentserver -h
Usage of contentserver: Serves content tree structures very quickly
-address string
address to bind socket server host:port Usage:
-debug contentserver [command]
toggle debug mode
-free-os-mem int Available Commands:
free OS mem every X minutes completion Generate the autocompletion script for the specified shell
-heap-dump int help Help about any command
dump heap every X minutes http Start http server
-var-dir string socket Start socket server
where to put my data (default "/var/lib/contentserver") version Print version information
-version
version info Flags:
-webserver-address string -h, --help help for contentserver
address to bind web server host:port, when empty no webserver will be spawned --log-format string log format (default "json")
-webserver-path string --log-level string log level (default "info")
path to export the webserver on - useful when behind a proxy (default "/contentserver")
Use "contentserver [command] --help" for more information about a command.
``` ```
## How to Contribute ## How to Contribute
Make a pull request... Please refer to the [CONTRIBUTING](.github/CONTRIBUTING.md) details and follow the [CODE_OF_CONDUCT](.github/CODE_OF_CONDUCT.md) and [SECURITY](.github/SECURITY.md) guidelines.
## License ## License