From ee7446f04f6557bb40c4e4c975a9c584067f3b82 Mon Sep 17 00:00:00 2001 From: Nutomic Date: Mon, 14 Mar 2022 18:34:25 +0000 Subject: [PATCH] Update docs for 0.16 (#125) * Update docs for 0.16 * Add note about resource usage --- src/en/SUMMARY.md | 2 +- src/en/administration/administration.md | 2 ++ src/en/administration/theming.md | 7 +++++++ src/en/administration/troubleshooting.md | 6 +++++- src/en/client_development/theming.md | 19 ------------------- 5 files changed, 15 insertions(+), 21 deletions(-) create mode 100644 src/en/administration/theming.md delete mode 100644 src/en/client_development/theming.md diff --git a/src/en/SUMMARY.md b/src/en/SUMMARY.md index c2ffd51..e5932a2 100644 --- a/src/en/SUMMARY.md +++ b/src/en/SUMMARY.md @@ -11,6 +11,7 @@ - [Install on AWS](administration/on_aws.md) - [First Steps](administration/first_steps.md) - [Configuration](administration/configuration.md) + - [Theming Guide](client_development/theming.md) - [Getting started with Federation](administration/federation_getting_started.md) - [Troubleshooting](administration/troubleshooting.md) - [Backup and Restore](administration/backup_and_restore.md) @@ -19,7 +20,6 @@ - [Lemmy Protocol](federation/lemmy_protocol.md) - [Client Development](client_development/client_development.md) - [HTTP API extras](client_development/http_api_extras.md) - - [Theming Guide](client_development/theming.md) - [Creating a Custom Frontend](client_development/custom_frontend.md) - [Contributing](contributing/contributing.md) - [Docker Development](contributing/docker_development.md) diff --git a/src/en/administration/administration.md b/src/en/administration/administration.md index 7a119c1..d34647c 100644 --- a/src/en/administration/administration.md +++ b/src/en/administration/administration.md @@ -11,6 +11,8 @@ Lemmy has two primary installation methods: We recommend using Ansible, because it simplifies the installation and also makes updating easier. +Lemmy uses roughly 150 MB of RAM in the default Docker installation. CPU usage is negligible. + ### Other installation methods > ⚠️ **Under your own risk.** diff --git a/src/en/administration/theming.md b/src/en/administration/theming.md new file mode 100644 index 0000000..f0337cf --- /dev/null +++ b/src/en/administration/theming.md @@ -0,0 +1,7 @@ +# Theming Guide + +Lemmy uses [Bootstrap v4](https://getbootstrap.com/), and very few custom css classes, so any bootstrap v4 compatible theme should work fine. Use a tool like [bootstrap.build](https://bootstrap.build/) to create a bootstrap v4 theme. Export the `bootstrap.min.css` once you're done, and save the `_variables.scss` too. + +If you installed Lemmy with Docker, save your theme file to `./volumes/lemmy-ui/extra_themes`. For native installation (without Docker), themes are loaded by lemmy-ui from ./extra_themes folder. A different path can be specified with LEMMY_UI_EXTRA_THEMES_FOLDER environment variable. + +After a theme is added, users can select it under `/settings`. Admins can set a theme as site default under `/admin`. \ No newline at end of file diff --git a/src/en/administration/troubleshooting.md b/src/en/administration/troubleshooting.md index b890d6e..1923011 100644 --- a/src/en/administration/troubleshooting.md +++ b/src/en/administration/troubleshooting.md @@ -61,4 +61,8 @@ curl -H "Accept: application/activity+json" https://your-instance.com/comment/12 Check that [federation is allowed on both instances](../federation/administration.md#instance-allowlist-and-blocklist). -Also ensure that the time is accurately set on your server. Activities are signed with a timestamp, and will be discarded if it is off by more than 10 seconds. \ No newline at end of file +Also ensure that the time is accurately set on your server. Activities are signed with a timestamp, and will be discarded if it is off by more than 10 seconds. + +### Other instances don't receive actions reliably + +Lemmy uses a queue to send out activities. The size of this queue is specified by the config value `federation.worker_count`. Very large instances might need to increase this value. Search the logs for "Activity queue stats", if it is consistently larger than the worker_count (default: 64), the count needs to be increased. diff --git a/src/en/client_development/theming.md b/src/en/client_development/theming.md deleted file mode 100644 index 2610b5f..0000000 --- a/src/en/client_development/theming.md +++ /dev/null @@ -1,19 +0,0 @@ -# Theming Guide - -Lemmy uses [Bootstrap v4](https://getbootstrap.com/), and very few custom css classes, so any bootstrap v4 compatible theme should work fine. - -## Creating - -- Use a tool like [bootstrap.build](https://bootstrap.build/) to create a bootstrap v4 theme. Export the `bootstrap.min.css` once you're done, and save the `_variables.scss` too. - -## Testing - -- To test out a theme, you can either use your browser's web tools, or a plugin like stylus to copy-paste a theme, when viewing Lemmy. - -## Adding - -1. Fork the [lemmy-ui](https://github.com/LemmyNet/lemmy-ui). -1. Copy `{my-theme-name}.min.css` to `src/assets/css/themes`. (You can also copy the `_variables.scss` here if you want). -1. Go to `src/shared/utils.ts` and add `{my-theme-name}` to the themes list. -1. Test locally -1. Do a pull request with those changes.