gitea/opengist
0
0
Fork 0
mirror of https://github.com/thomiceli/opengist.git synced 2025-07-10 18:01:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add custom instance names (#399)

Browse Source 
* Add custom name variable

* Add custom name variable usage to docs

* Remove leftover testing config options (oops)
This commit is contained in:
Sangelo
2024-12-15 17:39:51 +01:00
committed by GitHub
parent 00951bf63b
commit 20aef5e694
6 changed files with 1401 additions and 1387 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/configuration/cheat-sheet.md
View File

@ -37,6 +37,7 @@ aside: false
| oidc.client-key | OG_OIDC_CLIENT_KEY | none | The client key for the OpenID application. |
| oidc.secret | OG_OIDC_SECRET | none | The secret for the OpenID application. |
| oidc.discovery-url | OG_OIDC_DISCOVERY_URL | none | Discovery endpoint of the OpenID provider. |
| custom.name | OG_CUSTOM_NAME | none | The name of your instance, to be displayed in the tab title |
| custom.logo | OG_CUSTOM_LOGO | none | Path to an image, relative to $opengist-home/custom. |
| custom.favicon | OG_CUSTOM_FAVICON | none | Path to an image, relative to $opengist-home/custom. |
| custom.static-links | OG_CUSTOM_STATIC_LINK_#_(PATH,NAME) | none | Path and name to custom links, more info [here](custom-links.md). |

16
docs/configuration/custom-assets.md
View File

@ -28,4 +28,18 @@ custom.favicon: favicon.png
#### Environment variable
```sh
export OG_CUSTOM_FAVICON=favicon.png
```
```
### Instance Name
It is also possible to set a name for your instance, that would be displayed in the title bar instead of 'Opengist'.
#### YAML
```yaml
custom.name: My Gists
```
#### Environment variable
```sh
export OG_CUSTOM_NAME="My Gists"
```