diff --git a/docs/index.html b/docs/index.html index 6c4d1a5..ecbf621 100644 --- a/docs/index.html +++ b/docs/index.html @@ -50,7 +50,7 @@
-This program acts as a proxy to serve files directly from repositories.
It expects the following environment variables to be set:
API_URL - Base Forgejo API url (ex. https://git.brut.systems)API_TOKEN - Forgejo API authorization tokenREDIRECT_URL - Redirect url when access fails or files do not exist (ex. https://git.brut.systems)PORT - Port to listen onCreate a file at /etc/systemd/system/docs.brut.service with the following:
[Unit]
+ Docs.Brut.Systems
This program acts as a proxy to serve files directly from repositories.
It expects the following environment variables to be set:
API_URL - Base Forgejo API url (ex. https://git.brut.systems)API_TOKEN - Forgejo API authorization tokenREDIRECT_URL - Redirect url when access fails or files do not exist (ex. https://git.brut.systems)PORT - Port to listen on
How It Works
When a request like http://localhost:8080/user/repository/path/to/file is sent to the proxy, it will dynamically fetch that file from the repository and return it to the user.
Usage With Systemd
Create a file at /etc/systemd/system/docs.brut.service with the following:
[Unit]
Description=Serves files from Git repositories
After=network.target
[Service]
@@ -68,6 +68,6 @@ Environment="PORT=<port>"
WantedBy=multi-user.target
Then start the service:
sudo systemctl enable docs.brut
sudo systemctl start docs.brut
-
+Those with repositories on git.brut.systems can serve websites by creating a docs/ folder (on the default branch). While any file from the repository can be accessed, files within docs/ are accessible from /. If a file within docs/ conflicts with another file in the repository, the file in docs/ take precedence.