This commit is contained in:
Judah Caruso 2026-01-28 16:52:39 -07:00
parent 67b2e93122
commit d61374b9e2

View file

@ -50,7 +50,7 @@
</style> </style>
</head> </head>
<body> <body>
<h1>Docs.Brut.Systems</h1><p>This program acts as a proxy to serve files directly from repositories.</p><p>It expects the following environment variables to be set:</p><ul><li><code>API_URL</code> - Base Forgejo API url (ex. <code>https://git.brut.systems</code>)</li><li><code>API_TOKEN</code> - Forgejo API authorization token</li><li><code>REDIRECT_URL</code> - Redirect url when access fails or files do not exist (ex. <code>https://git.brut.systems</code>)</li><li><code>PORT</code> - Port to listen on</li></ul><h2>How It Works</h2><p>When a request like <code>http://localhost:8080/user/repository/path/to/file</code> is sent to the proxy, it will dynamically fetch that file from the repository and return it to the user.</p><h2>Usage With Systemd</h2><p>Create a file at <code>/etc/systemd/system/docs.brut.service</code> with the following:</p><pre><code>[Unit] <h1>Docs.Brut.Systems</h1><p>This program acts as a proxy to serve files directly from repositories.</p><p>It expects the following environment variables to be set:</p><ul><li><code>API_URL</code> - Base Forgejo API url (ex. <code>https://git.brut.systems</code>)</li><li><code>API_TOKEN</code> - Forgejo API authorization token</li><li><code>REDIRECT_URL</code> - Redirect url when access fails or files do not exist (ex. <code>https://git.brut.systems</code>)</li><li><code>PORT</code> - Port to listen on</li></ul><h2>How It Works</h2><p>When a request like <code>http://:PORT/user/repository/path/to/file</code> is sent to the proxy, it will dynamically fetch that file from the repository and return it to the user.</p><h2>Usage With Systemd</h2><p>Create a file at <code>/etc/systemd/system/docs.brut.service</code> with the following:</p><pre><code>[Unit]
Description=Serves files from Git repositories Description=Serves files from Git repositories
After=network.target After=network.target
</code></pre><pre><code>[Service] </code></pre><pre><code>[Service]