Add more readme
parent: tbd commit: d3837cd
Showing 1 changed file with 45 insertions and 0 deletions
giterated-daemon/README.md
| @@ -0,0 +1,45 @@ | ||
| 1 | # Installation | |
| 2 | ||
| 3 | Giterated is in very early development. These are best effort instructions on how setting up your own instance works. | |
| 4 | ||
| 5 | ## Requirements | |
| 6 | ||
| 7 | - Rust | |
| 8 | - nginx | |
| 9 | - postgresql | |
| 10 | ||
| 11 | ### Configuration | |
| 12 | ||
| 13 | The Giterated daemon requires a configuration file to function, it should be defined as follows: | |
| 14 | ||
| 15 | ``` | |
| 16 | [postgres] | |
| 17 | host = "127.0.0.1" | |
| 18 | port = 5432 | |
| 19 | database = "DATABASE_NAME" | |
| 20 | user = "LOGIN_USERNAME" | |
| 21 | password = "LOGIN_PASSWORD" | |
| 22 | ||
| 23 | [giterated] | |
| 24 | instance = "YOUR_INSTANCE_PUBLIC_URL" | |
| 25 | ||
| 26 | [giterated.discovery] | |
| 27 | peers = [ | |
| 28 | # A list of instance URLs you're peering with for discovery | |
| 29 | ] | |
| 30 | ||
| 31 | [giterated.backend.git] | |
| 32 | root = "GIT_REPOSITORY_STORAGE_ROOT_DIRECTORY" | |
| 33 | ||
| 34 | [giterated.keys] | |
| 35 | private = "PRIVATE_KEY_LOCATION" | |
| 36 | public = "PUBLIC_KEY_LOCATION" | |
| 37 | ``` | |
| 38 | ||
| 39 | ### nginx setup | |
| 40 | ||
| 41 | Your Giterated public key must be served on `/.giterated/pubkey.pem`. Forward all other routes to your choice of frontend. | |
| 42 | ||
| 43 | ### Frontend Setup | |
| 44 | ||
| 45 | You may set up a frontend to allow access to your instance through a browser (you most likely want to do this). Currently the only supported frontend is the official `giterated-frontend` frontend. Eventually it'll be linked here, try https://giterated.dev/emilia/giterated-frontend. | |
| 45 | \ No newline at end of file | |