mirror of
https://github.com/stonith404/pingvin-share.git
synced 2024-11-15 11:50:34 +01:00
Add basic configuration to the docs (#587)
* Created website for the docs inside /docs * remove old docs and home page * fix wrong redirection path * remove most of the docs from the readme * fix docs path * undo package.json changes * remove unused images * rename "how to" route * Add basic configuration to the docs --------- Co-authored-by: Elias Schneider <login@eliasschneider.com>
This commit is contained in:
parent
be202d3d41
commit
15d1756a4e
@ -4,13 +4,35 @@ id: configuration
|
|||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
|
|
||||||
You can customize Pingvin Share like changing your domain by going to the configuration page in your admin dashboard `/admin/config`.
|
You can customize Pingvin Share by going to the configuration page in your admin dashboard `/admin/config`.
|
||||||
|
|
||||||
#### Environment variables
|
## General
|
||||||
|
|
||||||
|
The **General** Tab will let you customize your Pingvin Share instance to your liking.
|
||||||
|
|
||||||
|
### App name
|
||||||
|
|
||||||
|
To change the name of your instance, insert any text into `App name`.
|
||||||
|
|
||||||
|
### App URL
|
||||||
|
|
||||||
|
To make your App available trough your own **domain**, insert your specific domain and also subdomain if needed. Add an `https://` if you have an SSL certificate installed. If this is not the case, use `http://`.
|
||||||
|
|
||||||
|
### Show home page
|
||||||
|
|
||||||
|
If you don't like the **home page** Pingvin Share provides and you just want the upload tab to be the main page, toggle this to `true`.
|
||||||
|
|
||||||
|
### Logo
|
||||||
|
|
||||||
|
Not only you can change your instances name, but also the logo it shows everywhere. To do that, upload an image as `png` with a 1:1 aspect ratio.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Environment variables
|
||||||
|
|
||||||
For installation specific configuration, you can use environment variables. The following variables are available:
|
For installation specific configuration, you can use environment variables. The following variables are available:
|
||||||
|
|
||||||
##### Backend
|
#### Backend
|
||||||
|
|
||||||
| Variable | Default Value | Description |
|
| Variable | Default Value | Description |
|
||||||
| ---------------- | -------------------------------------------------- | -------------------------------------- |
|
| ---------------- | -------------------------------------------------- | -------------------------------------- |
|
||||||
@ -20,7 +42,7 @@ For installation specific configuration, you can use environment variables. The
|
|||||||
| `CLAMAV_HOST` | `127.0.0.1` | The IP address of the ClamAV server. |
|
| `CLAMAV_HOST` | `127.0.0.1` | The IP address of the ClamAV server. |
|
||||||
| `CLAMAV_PORT` | `3310` | The port number of the ClamAV server. |
|
| `CLAMAV_PORT` | `3310` | The port number of the ClamAV server. |
|
||||||
|
|
||||||
##### Frontend
|
#### Frontend
|
||||||
|
|
||||||
| Variable | Default Value | Description |
|
| Variable | Default Value | Description |
|
||||||
| --------- | ----------------------- | ---------------------------------------- |
|
| --------- | ----------------------- | ---------------------------------------- |
|
||||||
|
@ -7,7 +7,7 @@ const config: Config = {
|
|||||||
tagline:
|
tagline:
|
||||||
"Pingvin Share is self-hosted file sharing platform and an alternative for WeTransfer.",
|
"Pingvin Share is self-hosted file sharing platform and an alternative for WeTransfer.",
|
||||||
favicon: "img/pingvinshare.svg",
|
favicon: "img/pingvinshare.svg",
|
||||||
|
|
||||||
url: "https://stonith404.github.io",
|
url: "https://stonith404.github.io",
|
||||||
baseUrl: "/pingvin-share/",
|
baseUrl: "/pingvin-share/",
|
||||||
organizationName: "stonith404",
|
organizationName: "stonith404",
|
||||||
@ -37,7 +37,7 @@ const config: Config = {
|
|||||||
|
|
||||||
themeConfig: {
|
themeConfig: {
|
||||||
image: "img/pingvinshare.svg",
|
image: "img/pingvinshare.svg",
|
||||||
colorMode:{
|
colorMode: {
|
||||||
respectPrefersColorScheme: true,
|
respectPrefersColorScheme: true,
|
||||||
},
|
},
|
||||||
navbar: {
|
navbar: {
|
||||||
|
Loading…
Reference in New Issue
Block a user