update readme a bit
This commit is contained in:
parent
9d53fc171a
commit
92895f4e09
30
README.md
30
README.md
@ -1,31 +1,9 @@
|
||||
# gavin
|
||||
|
||||
[![builds.sr.ht status](https://builds.sr.ht/~qbit/gavin.svg)](https://builds.sr.ht/~qbit/gavin?)
|
||||
*gavin* is a self contained instance of [Organice](https://github.com/200ok-ch/organice).
|
||||
|
||||
Simple utility to serve password protected, HTTPS'd WebDAV server and
|
||||
[Organice](https://github.com/200ok-ch/organice) instance.
|
||||
It combines a WebDAV server and the Organice assets into a single binary that
|
||||
can be run from virtually everywhere.
|
||||
|
||||
## Installation
|
||||
`gavin` can be used as a standalone webserver or placed behind a reverse proxy.
|
||||
|
||||
```
|
||||
go git -u suah.dev/gavin
|
||||
```
|
||||
|
||||
## Example usage
|
||||
|
||||
`gavin` was built as a simple WebDAV server specifically to run
|
||||
[organice](https://github.com/200ok-ch/organice). Here is an example showing how
|
||||
to host organice via WebDAV.
|
||||
|
||||
| Flag | Value | Description |
|
||||
|-----------|---------------------|-----------------------------------------------------------------------------------------|
|
||||
| `-davdir` | /tmp/org | The directory we have our .org files in. |
|
||||
| `-htpass` | /tmp/.htpasswd | Standard `htpasswd` file generated with `htpasswd`. Currently only bcrypt is supported. |
|
||||
|
||||
```
|
||||
gavin -davdir /tmp/org -htpass /tmp/.htpasswd
|
||||
```
|
||||
|
||||
Now you can open your browser to
|
||||
[http://localhost:8080/](http://localhost:8080/), sign in using the credentials
|
||||
in the `.htpasswd` file, and org away!
|
||||
|
Loading…
Reference in New Issue
Block a user