Update docs for 0.16 (#125)

* Update docs for 0.16

* Add note about resource usage
This commit is contained in:
Nutomic 2022-03-14 18:34:25 +00:00 committed by GitHub
parent 2a1bd5f957
commit ee7446f04f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 21 deletions

View file

@ -11,6 +11,7 @@
- [Install on AWS](administration/on_aws.md) - [Install on AWS](administration/on_aws.md)
- [First Steps](administration/first_steps.md) - [First Steps](administration/first_steps.md)
- [Configuration](administration/configuration.md) - [Configuration](administration/configuration.md)
- [Theming Guide](client_development/theming.md)
- [Getting started with Federation](administration/federation_getting_started.md) - [Getting started with Federation](administration/federation_getting_started.md)
- [Troubleshooting](administration/troubleshooting.md) - [Troubleshooting](administration/troubleshooting.md)
- [Backup and Restore](administration/backup_and_restore.md) - [Backup and Restore](administration/backup_and_restore.md)
@ -19,7 +20,6 @@
- [Lemmy Protocol](federation/lemmy_protocol.md) - [Lemmy Protocol](federation/lemmy_protocol.md)
- [Client Development](client_development/client_development.md) - [Client Development](client_development/client_development.md)
- [HTTP API extras](client_development/http_api_extras.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) - [Creating a Custom Frontend](client_development/custom_frontend.md)
- [Contributing](contributing/contributing.md) - [Contributing](contributing/contributing.md)
- [Docker Development](contributing/docker_development.md) - [Docker Development](contributing/docker_development.md)

View file

@ -11,6 +11,8 @@ Lemmy has two primary installation methods:
We recommend using Ansible, because it simplifies the installation and also makes updating easier. 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 ### Other installation methods
> ⚠️ **Under your own risk.** > ⚠️ **Under your own risk.**

View file

@ -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`.

View file

@ -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). 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. 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.

View file

@ -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.