Fix the sentence and add the setting example

This commit is contained in:
Aries 2019-07-23 09:55:58 +09:00
parent 63924ee712
commit 1e7d68e8bf
1 changed files with 27 additions and 24 deletions

View File

@ -7,7 +7,11 @@ config :pleroma, :instance,
static_dir: "instance/static/", static_dir: "instance/static/",
``` ```
You can overwrite this value in your configuration to use a different static instance directory. For example, edit `instance/static/instance/panel.html` .
Alternatively, you can overwrite this value in your configuration to use a different static instance directory.
This document is written assuming `instance/static/`.
## robots.txt ## robots.txt
@ -19,46 +23,45 @@ If you want to generate a restrictive `robots.txt`, you can run the following mi
mix pleroma.robots_txt disallow_all mix pleroma.robots_txt disallow_all
``` ```
# Small customizations
You can directly overwrite files in `priv/static`, but you can also use`instance/static`.
Since `priv` is tracked by git, it is recommended to put panel.html or thumbnail.jpeg and more under the `instance` directory if you do not use your own pleroma git repository.
For example, `instance/static/instance/panel.html`
This is when static_dir is the default.
## Thumbnail ## Thumbnail
Replace `priv/static/instance/thumbnail.jpeg` with your selfie or other neat picture. It will appear in [Pleroma Instances](http://distsn.org/pleroma-instances.html). Put on `instance/static/instance/thumbnail.jpeg` with your selfie or other neat picture. It will appear in [Pleroma Instances](http://distsn.org/pleroma-instances.html).
Or put your file on `instance/static/instance/thumbnail.jpeg` when static_dir is default.
## Instance-specific panel ## Instance-specific panel
![instance-specific panel demo](/uploads/296b19ec806b130e0b49b16bfe29ce8a/image.png) ![instance-specific panel demo](/uploads/296b19ec806b130e0b49b16bfe29ce8a/image.png)
To show the instance specific panel, set `show_instance_panel` to `true` in `config/dev.secret.exs`. You can modify its content by editing `priv/static/instance/panel.html`. Create and Edit your file on `instance/static/instance/panel.html`.
Or put your file on `instance/static/instance/panel.html` when static_dir is default.
## Background ## Background
You can change the background of your Pleroma instance by uploading it to `priv/static/static`, and then changing `"background"` in `config/dev.secret.exs` accordingly. You can change the background of your Pleroma instance by uploading it to `instance/static/`, and then changing `background` in `config/prod.secret.exs` accordingly.
Or put your file on `instance/static/static/background.jpg` when static_dir is default. If you put `instance/static/images/background.jpg`
```
config :pleroma, :frontend_configurations,
pleroma_fe: %{
background: "/images/background.jpg"
}
```
## Logo ## Logo
![logo modification demo](/uploads/c70b14de60fa74245e7f0dcfa695ebff/image.png) ![logo modification demo](/uploads/c70b14de60fa74245e7f0dcfa695ebff/image.png)
If you want to give a brand to your instance, look no further. You can change the logo of your instance by uploading it to `priv/static/static`, and then changing `logo` in `config/dev.secret.exs` accordingly. If you want to give a brand to your instance, You can change the logo of your instance by uploading it to `instance/static/`.
Or put your file on `instance/static/static/logo.png` when static_dir is default. Alternatively, you can specify the path with config.
If you put `instance/static/static/mylogo-file.png`
```
config :pleroma, :frontend_configurations,
pleroma_fe: %{
logo: "/static/mylogo-file.png"
}
```
## Terms of Service ## Terms of Service
Terms of Service will be shown to all users on the registration page. It's the best place where to write down the rules for your instance. You can modify the rules by changing `priv/static/static/terms-of-service.html`. Terms of Service will be shown to all users on the registration page. It's the best place where to write down the rules for your instance. You can modify the rules by changing `instance/static/static/terms-of-service.html`.
Or put your file on `instance/static/static/terms-of-service.html` when static_dir is default.