diff options
| author | Julian Hurst <ark@mansus.space> | 2022-12-08 18:34:25 +0100 |
|---|---|---|
| committer | Julian Hurst <ark@mansus.space> | 2022-12-08 18:34:25 +0100 |
| commit | 238d7a12de4ad095c297f214a76438110798208b (patch) | |
| tree | 104f42f9f4a1bfc8b3a32723091a229e384e50a4 /README.md | |
| download | autoindex-238d7a12de4ad095c297f214a76438110798208b.tar.gz | |
Initial commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..89253a8 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# autoindex + +## Usage + Usage of ./autoindex: + -E Encrypt the data with a specified password + -b string + The autoindex executables directory. + -e Encrypt the data with a cryptographically secure generated hash + -p int + The port to bind to. (default 8080) + +## Build & install + +To build autoindex, install go and run: + + $ go build + +To install, you can run: + + # GOBIN=/usr/local/bin go install + +or + + $ GOBIN=$HOME/.local/bin go install + +The index.html file must be placed in $HOME/.local/share/autoindex. |