static_dir.md (2454B)
1 # Static Directory
2
3 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/`.
4
5 ```
6 config :pleroma, :instance,
7 static_dir: "instance/static/",
8 ```
9
10 For example, edit `instance/static/instance/panel.html` .
11
12 Alternatively, you can overwrite this value in your configuration to use a different static instance directory.
13
14 This document is written assuming `instance/static/`.
15
16 Or, if you want to manage your custom file in git repository, basically remove the `instance/` entry from `.gitignore`.
17
18 ## robots.txt
19
20 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.
21
22 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.
23
24 ```
25 mix pleroma.robots_txt disallow_all
26 ```
27
28 ## Thumbnail
29
30 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).
31
32 ## Instance-specific panel
33
34 
35
36 Create and Edit your file on `instance/static/instance/panel.html`.
37
38 ## Background
39
40 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.
41
42 If you put `instance/static/images/background.jpg`
43
44 ```
45 config :pleroma, :frontend_configurations,
46 pleroma_fe: %{
47 background: "/images/background.jpg"
48 }
49 ```
50
51 ## Logo
52
53 
54
55 If you want to give a brand to your instance, You can change the logo of your instance by uploading it to `instance/static/`.
56
57 Alternatively, you can specify the path with config.
58 If you put `instance/static/static/mylogo-file.png`
59
60 ```
61 config :pleroma, :frontend_configurations,
62 pleroma_fe: %{
63 logo: "/static/mylogo-file.png"
64 }
65 ```
66
67 ## Terms of Service
68
69 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`.