From 59b2951a360e943f8182e9264623e5fa394ed508 Mon Sep 17 00:00:00 2001 From: Judah Caruso Date: Wed, 28 Jan 2026 16:51:07 -0700 Subject: [PATCH] update docs --- docs/index.html | 4 ++-- docs/index.riv | 12 +++++++++++- 2 files changed, 13 insertions(+), 3 deletions(-) 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 @@ -

Docs.Brut.Systems

This program acts as a proxy to serve files directly from repositories.

It expects the following environment variables to be set:

Usage W/ Systemd

Create 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 token
  • REDIRECT_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
-

+

Usage Within Git.Brut.Systems

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.

\ No newline at end of file diff --git a/docs/index.riv b/docs/index.riv index 6100e19..7e7ffb5 100644 --- a/docs/index.riv +++ b/docs/index.riv @@ -10,7 +10,12 @@ It expects the following environment variables to be set: - `PORT` - Port to listen on -USAGE W/ SYSTEMD +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: @@ -37,3 +42,8 @@ Then start the service: sudo systemctl enable docs.brut sudo systemctl start docs.brut + + +USAGE WITHIN GIT.BRUT.SYSTEMS + +Those with repositories on [https://git.brut.systems 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.