Update README with --admin-prefix info
This commit is contained in:
Seednode
parent
14adbdf742
commit
f3ee295663
87
README.md
87
README.md
|
|
@ -19,6 +19,25 @@ Dockerfile available [here](https://git.seedno.de/seednode/roulette/raw/branch/m
|
||||||
|
|
||||||
An example instance with most features enabled can be found [here](https://nature.seedno.de/).
|
An example instance with most features enabled can be found [here](https://nature.seedno.de/).
|
||||||
|
|
||||||
|
## Admin prefix
|
||||||
|
You can restrict access to certain functionality by prepending a secret string to the paths.
|
||||||
|
|
||||||
|
For example, providing the `--admin-prefix=abc123` flag will register the index rebuild path as `/abc123/index/rebuild`.
|
||||||
|
|
||||||
|
The affected paths are:
|
||||||
|
- `/debug/pprof/`
|
||||||
|
- `/debug/pprof/cmdline`
|
||||||
|
- `/debug/pprof/profile`
|
||||||
|
- `/debug/pprof/symbol`
|
||||||
|
- `/debug/pprof/trace`
|
||||||
|
- `/extensions/available`
|
||||||
|
- `/extensions/enabled`
|
||||||
|
- `/index/html`
|
||||||
|
- `/index/json`
|
||||||
|
- `/index/rebuild`
|
||||||
|
- `/types/available`
|
||||||
|
- `/types/enabled`
|
||||||
|
|
||||||
## Filtering
|
## Filtering
|
||||||
You can provide a comma-delimited string of alphanumeric patterns to match via the `include=` query parameter, assuming the `-f|--filter` flag is enabled.
|
You can provide a comma-delimited string of alphanumeric patterns to match via the `include=` query parameter, assuming the `-f|--filter` flag is enabled.
|
||||||
|
|
||||||
|
|
@ -113,39 +132,41 @@ Usage:
|
||||||
roulette <path> [path]... [flags]
|
roulette <path> [path]... [flags]
|
||||||
|
|
||||||
Flags:
|
Flags:
|
||||||
-a, --all enable all supported file types
|
--admin-prefix string string to prepend to administrative paths
|
||||||
--audio enable support for audio files
|
-a, --all enable all supported file types
|
||||||
-b, --bind string address to bind to (default "0.0.0.0")
|
--audio enable support for audio files
|
||||||
--case-sensitive use case-sensitive matching for filters
|
-b, --bind string address to bind to (default "0.0.0.0")
|
||||||
--code enable support for source code files
|
--case-sensitive use case-sensitive matching for filters
|
||||||
--code-theme string theme for source code syntax highlighting (default "solarized-dark256")
|
--code enable support for source code files
|
||||||
--disable-buttons disable first/prev/next/last buttons
|
--code-theme string theme for source code syntax highlighting (default "solarized-dark256")
|
||||||
--exit-on-error shut down webserver on error, instead of just printing the error
|
--concurrency int maximum concurrency for scan threads (default 1024)
|
||||||
--fallback serve files as application/octet-stream if no matching format is registered
|
--disable-buttons disable first/prev/next/last buttons
|
||||||
-f, --filter enable filtering
|
--exit-on-error shut down webserver on error, instead of just printing the error
|
||||||
--flash enable support for shockwave flash files (via ruffle.rs)
|
--fallback serve files as application/octet-stream if no matching format is registered
|
||||||
--fun add a bit of excitement to your day
|
-f, --filter enable filtering
|
||||||
--handlers display registered handlers (for debugging)
|
--flash enable support for shockwave flash files (via ruffle.rs)
|
||||||
-h, --help help for roulette
|
--fun add a bit of excitement to your day
|
||||||
--ignore skip all directories containing a file named .roulette_ignore
|
--handlers display registered handlers (for debugging)
|
||||||
--images enable support for image files
|
-h, --help help for roulette
|
||||||
--index generate index of supported file paths at startup
|
--ignore skip all directories containing a file named .roulette_ignore
|
||||||
--index-file string path to optional persistent index file
|
--images enable support for image files
|
||||||
-i, --info expose informational endpoints
|
--index generate index of supported file paths at startup
|
||||||
--max-file-count int skip directories with file counts above this value (default 2147483647)
|
--index-file string path to optional persistent index file
|
||||||
--min-file-count int skip directories with file counts below this value
|
-i, --info expose informational endpoints
|
||||||
--page-length int pagination length for info pages
|
--max-file-count int skip directories with file counts above this value (default 2147483647)
|
||||||
-p, --port int port to listen on (default 8080)
|
--min-file-count int skip directories with file counts below this value
|
||||||
--prefix string root path for http handlers (for reverse proxying) (default "/")
|
--page-length int pagination length for info pages
|
||||||
--profile register net/http/pprof handlers
|
-p, --port int port to listen on (default 8080)
|
||||||
-r, --recursive recurse into subdirectories
|
--prefix string root path for http handlers (for reverse proxying) (default "/")
|
||||||
--refresh enable automatic page refresh via query parameter
|
--profile register net/http/pprof handlers
|
||||||
--russian remove selected images after serving
|
-r, --recursive recurse into subdirectories
|
||||||
-s, --sort enable sorting
|
--refresh enable automatic page refresh via query parameter
|
||||||
--text enable support for text files
|
--russian remove selected images after serving
|
||||||
-v, --verbose log accessed files and other information to stdout
|
-s, --sort enable sorting
|
||||||
-V, --version display version and exit
|
--text enable support for text files
|
||||||
--video enable support for video files
|
-v, --verbose log accessed files and other information to stdout
|
||||||
|
-V, --version display version and exit
|
||||||
|
--video enable support for video files
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building the Docker container
|
## Building the Docker container
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue