You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,29 +36,33 @@ To use it with your repos, please note the following.
36
36
REPO_DIR=/repositories
37
37
```
38
38
39
-
3. A `config.toml` file also needs to be created and placed at `$HOME/.config/config`. Within the `config.toml` there must be a list of namespace dirs and repo dirs which are allowed to be served, and a title, which may be left blank if unneeded.
39
+
3. A `gemini-git-browser.toml` file also needs to be created and placed at `$XDG_CONFIG_HOME/gemini-git-browser`. `XDG_CONFIG_HOME` is usually set to `$HOME/.config` on linux. Within the `gemini-git-browser.toml` there must be a list of namespace dirs and repo dirs which are allowed to be served, and a title, which may be left blank if unneeded.
Once the `REPO_DIR` variable and `config.toml` file is set, executing the binary should serve the repos at the gemini port.
47
+
Once the `REPO_DIR` variable and `gemini-git-browser.toml` file is set, executing the binary should serve the repos at the gemini port.
48
48
49
49
## Run from Docker
50
50
51
-
The UI is also packaged as a docker image for easy deployment. To run it, create the `config.toml` file and a TLS certificate and private key first (gemini uses TLS by default), then mount the `config.toml`, the certificate and private key and your repository directory into the container with the following command.
51
+
The UI is also packaged as a docker image for easy deployment. To run it:
52
+
53
+
- create the `gemini-git-browser.toml` file
54
+
- a TLS certificate and private key (gemini uses TLS by default)
55
+
- mount the `gemini-git-browser.toml`, the certificate and private key and your repository directory into the container with the following command:
52
56
53
57
```
54
-
# Paths used for the certificate and key are default let's encrypt paths
The paths used in this example are the default let's encrypt certificate and key paths and the default location of the `gemini-git-browser.toml` file. Please adjust the command accordingly if your certificate or toml file paths are different.
62
66
63
67
Once the container is running you can access the UI at gemini://localhost/
0 commit comments