logo

pleroma

My custom branche(s) on git.pleroma.social/pleroma/pleroma git clone https://hacktivis.me/git/pleroma.git

static_dir.md (3246B)

    

  1. # Static Directory
  3. Static frontend files are shipped with pleroma. If you want to overwrite or update these without problems during upgrades, you can write your custom versions to the static directory.
  5. You can find the location of the static directory in the [configuration](../cheatsheet/#instance).
  7. === "OTP"
  9.     ```elixir
  10.     config :pleroma, :instance,
  11.       static_dir: "/var/lib/pleroma/static/"
  12.     ```
  14. === "From Source"
  16.     ```elixir
  17.     config :pleroma, :instance,
  18.     static_dir: "instance/static/"
  19.     ```
  21. Alternatively, you can overwrite this value in your configuration to use a different static instance directory.
  23. This document is written using `$static_dir` as the value of the `config :pleroma, :instance, static_dir` setting.
  25. If you use a From Source installation and want to manage your custom files in the git repository, you can remove the `instance/` entry from `.gitignore`.
  27. ## robots.txt
  29. There's a mix tasks to [generate a new robot.txt](../../administration/CLI_tasks/robots_txt/).
  31. For more complex things, you can write your own robots.txt to `$static_dir/robots.txt`.
  33. E.g. if you want to block all crawlers except for [fediverse.network](https://fediverse.network/about) you can use
  35. ```
  36. User-Agent: *
  37. Disallow: /
  39. User-Agent: crawler-us-il-1.fediverse.network
  40. Allow: /
  42. User-Agent: makhnovtchina.random.sh
  43. Allow: /
  44. ```
  46. ## Thumbnail
  48. Add `$static_dir/instance/thumbnail.jpeg` with your selfie or other neat picture. It will be available on `http://your-domain.tld/instance/thumbnail.jpeg` and can be used by external applications.
  50. ## Instance-specific panel
  52. Create and Edit your file at `$static_dir/instance/panel.html`.
  54. ## Background
  56. You can change the background of your Pleroma instance by uploading it to `$static_dir/`, and then changing `background` in [your configuration](../cheatsheet/#frontend_configurations) accordingly.
  58. E.g. if you put `$static_dir/images/background.jpg`
  60. ```
  61. config :pleroma, :frontend_configurations,
  62.   pleroma_fe: %{
  63.     background: "/images/background.jpg"
  64.   }
  65. ```
  67. ## Logo
  69. !!! important
  70.     Note the extra `static` folder for the default logo.png location
  72. If you want to give a brand to your instance, You can change the logo of your instance by uploading it to the static directory `$static_dir/static/logo.png`.
  74. Alternatively, you can specify the path to your logo in [your configuration](../cheatsheet/#frontend_configurations).
  76. E.g. if you put `$static_dir/static/mylogo-file.png`
  78. ```
  79. config :pleroma, :frontend_configurations,
  80.   pleroma_fe: %{
  81.    logo: "/static/mylogo-file.png"
  82.   }
  83. ```
  85. ## Terms of Service
  87. !!! important
  88.     Note the extra `static` folder for the terms-of-service.html
  90. 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 adding and changing `$static_dir/static/terms-of-service.html`.
  92.  	
  93. ## Styling rendered pages
  95. To overwrite the CSS stylesheet of the OAuth form and other static pages, you can upload your own CSS file to `instance/static/static.css`. This will completely replace the CSS used by those pages, so it might be a good idea to copy the one from `priv/static/instance/static.css` and make your changes.