diff --git a/README.md b/README.md index 3810d46..4a1d448 100644 --- a/README.md +++ b/README.md @@ -144,43 +144,44 @@ Usage: roulette [path]... [flags] Flags: - --admin-prefix string string to prepend to administrative paths - -a, --all enable all supported file types - --allow-empty allow specifying paths containing no supported files - --audio enable support for audio files - --binary-prefix use IEC binary prefixes instead of SI decimal prefixes - -b, --bind string address to bind to (default "0.0.0.0") - --case-insensitive use case-insensitive matching for filters - --code enable support for source code files - --code-theme string theme for source code syntax highlighting (default "solarized-dark256") - --concurrency int maximum concurrency for scan threads (default 1024) - -d, --debug display even more verbose logs - --disable-buttons disable first/prev/next/last buttons - --exit-on-error shut down webserver on error, instead of just printing error - --fallback serve files as application/octet-stream if no matching format is registered - -f, --filter enable filtering - --flash enable support for shockwave flash files (via ruffle.rs) - --fun add a bit of excitement to your day - -h, --help help for roulette - --ignore skip all directories containing a specified filename - --ignore-file string filename used to indicate directory should be skipped (default ".roulette-ignore") - --images enable support for image files - --index generate index of supported file paths at startup - --index-file string path to optional persistent index file - -i, --info expose informational endpoints - --max-file-count int skip directories with file counts above this value (default 2147483647) - --min-file-count int skip directories with file counts below this value - -p, --port int port to listen on (default 8080) - --prefix string root path for http handlers (for reverse proxying) (default "/") - --profile register net/http/pprof handlers - -r, --recursive recurse into subdirectories - --refresh enable automatic page refresh via query parameter - --russian remove selected images after serving - -s, --sort enable sorting - --text enable support for text files - -v, --verbose log accessed files and other information to stdout - -V, --version display version and exit - --video enable support for video files + --admin-prefix string string to prepend to administrative paths + -a, --all enable all supported file types + --allow-empty allow specifying paths containing no supported files + --audio enable support for audio files + --binary-prefix use IEC binary prefixes instead of SI decimal prefixes + -b, --bind string address to bind to (default "0.0.0.0") + --case-insensitive use case-insensitive matching for filters + --code enable support for source code files + --code-theme string theme for source code syntax highlighting (default "solarized-dark256") + --concurrency int maximum concurrency for scan threads (default 1024) + -d, --debug display even more verbose logs + --disable-buttons disable first/prev/next/last buttons + --exit-on-error shut down webserver on error, instead of just printing error + --fallback serve files as application/octet-stream if no matching format is registered + -f, --filter enable filtering + --flash enable support for shockwave flash files (via ruffle.rs) + --fun add a bit of excitement to your day + -h, --help help for roulette + --ignore skip all directories containing a specified filename + --ignore-file string filename used to indicate directory should be skipped (default ".roulette-ignore") + --images enable support for image files + --index generate index of supported file paths at startup + --index-file string path to optional persistent index file + --index-interval string interval at which to regenerate index (e.g. "3s" or "1h") + -i, --info expose informational endpoints + --max-file-count int skip directories with file counts above this value (default 2147483647) + --min-file-count int skip directories with file counts below this value + -p, --port int port to listen on (default 8080) + --prefix string root path for http handlers (for reverse proxying) (default "/") + --profile register net/http/pprof handlers + -r, --recursive recurse into subdirectories + --refresh enable automatic page refresh via query parameter + --russian remove selected images after serving + -s, --sort enable sorting + --text enable support for text 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 diff --git a/cmd/root.go b/cmd/root.go index 90ce92a..33427c8 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -17,7 +17,7 @@ import ( const ( AllowedCharacters string = `^[A-z0-9.\-_]+$` - ReleaseVersion string = "6.4.0" + ReleaseVersion string = "6.4.1" ) var ( @@ -137,7 +137,7 @@ func init() { rootCmd.Flags().BoolVar(&Images, "images", false, "enable support for image files") rootCmd.Flags().BoolVar(&Index, "index", false, "generate index of supported file paths at startup") rootCmd.Flags().StringVar(&IndexFile, "index-file", "", "path to optional persistent index file") - rootCmd.Flags().StringVar(&IndexInterval, "index-interval", "", "regenerate index after this amount of time") + rootCmd.Flags().StringVar(&IndexInterval, "index-interval", "", "interval at which to regenerate index (e.g. \"5m\" or \"1h\")") rootCmd.Flags().BoolVarP(&Info, "info", "i", false, "expose informational endpoints") rootCmd.Flags().IntVar(&MaxFileCount, "max-file-count", math.MaxInt32, "skip directories with file counts above this value") rootCmd.Flags().IntVar(&MinFileCount, "min-file-count", 0, "skip directories with file counts below this value")