alyssa
/
pleroma
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
pleroma/docs/configuration/static_dir.md

70 lines
2.4 KiB
Markdown
Raw Normal View History

robots.txt Add default robots.txt that allows bots access to all paths. Add mix task to generate robots.txt taht allows bots access to no paths. Document custom emojis, MRF and static_dir static_dir documentation includes docs for the robots.txt Mix task.
2019-01-20 01:44:00 +00:00
# Static Directory
Static frontend files are shipped in `priv/static/` and tracked by version control in this repository. If you want to overwrite or update these without the possibility of merge conflicts, you can write your custom versions to `instance/static/`.
```
config :pleroma, :instance,
static_dir: "instance/static/",
```
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
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 Add default robots.txt that allows bots access to all paths. Add mix task to generate robots.txt taht allows bots access to no paths. Document custom emojis, MRF and static_dir static_dir documentation includes docs for the robots.txt Mix task.
2019-01-20 01:44:00 +00:00
Add text about gitignore
2019-07-24 01:50:56 +00:00
Or, if you want to manage your custom file in git repository, basically remove the `instance/` entry from `.gitignore`.
robots.txt Add default robots.txt that allows bots access to all paths. Add mix task to generate robots.txt taht allows bots access to no paths. Document custom emojis, MRF and static_dir static_dir documentation includes docs for the robots.txt Mix task.
2019-01-20 01:44:00 +00:00
## robots.txt
By default, the `robots.txt` that ships in `priv/static/` is permissive. It allows well-behaved search engines to index all of your instance's URIs.
If you want to generate a restrictive `robots.txt`, you can run the following mix task. The generated `robots.txt` will be written in your instance static directory.
```
mix pleroma.robots_txt disallow_all
```
Fix static_dir docs
2019-07-22 09:46:32 +00:00
## Thumbnail
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
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).
Fix static_dir docs
2019-07-22 09:46:32 +00:00
## Instance-specific panel
![instance-specific panel demo](/uploads/296b19ec806b130e0b49b16bfe29ce8a/image.png)
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
Create and Edit your file on `instance/static/instance/panel.html`.
Fix static_dir docs
2019-07-22 09:46:32 +00:00
## Background
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
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.
If you put `instance/static/images/background.jpg`
Fix static_dir docs
2019-07-22 09:46:32 +00:00
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
```
config :pleroma, :frontend_configurations,
pleroma_fe: %{
background: "/images/background.jpg"
}
```
Fix static_dir docs
2019-07-22 09:46:32 +00:00
## Logo
![logo modification demo](/uploads/c70b14de60fa74245e7f0dcfa695ebff/image.png)
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
If you want to give a brand to your instance, You can change the logo of your instance by uploading it to `instance/static/`.
Fix static_dir docs
2019-07-22 09:46:32 +00:00
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
Alternatively, you can specify the path with config.
If you put `instance/static/static/mylogo-file.png`
Fix static_dir docs
2019-07-22 09:46:32 +00:00
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
```
config :pleroma, :frontend_configurations,
pleroma_fe: %{
logo: "/static/mylogo-file.png"
}
```
Fix static_dir docs
2019-07-22 09:46:32 +00:00
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
## Terms of Service
Fix static_dir docs
2019-07-22 09:46:32 +00:00
Fix the sentence and add the setting example
2019-07-23 00:55:58 +00:00
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`.