itepechi/akkoma
1
0
Fork 0
Code Issues Pull requests Releases Activity

docs: use highlight blocks where appropriate

Browse source
This commit is contained in:
solidsanek 2025-05-10 17:14:36 +02:00 committed by Oneric
parent 303f0931de
commit 23ee94c0d8
4 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/docs/administration/CLI_tasks/config.md
View file

@ -179,8 +179,9 @@ it may be easier to dump the values to JSON and then modify them in a text edito
## Loading specific configuration values from JSON ## Loading specific configuration values from JSON
**Note:** This will overwrite any existing value in the database, and can !!!note
cause crashes if you do not have exactly the correct formatting. This will overwrite any existing value in the database, and can
cause crashes if you do not have exactly the correct formatting.
Once you have modified the JSON file, you can load it back into the database. Once you have modified the JSON file, you can load it back into the database.
@ -200,6 +201,7 @@ Once you have modified the JSON file, you can load it back into the database.
mix pleroma.config load_from_file /tmp/mrf_simple.json mix pleroma.config load_from_file /tmp/mrf_simple.json
``` ```
**NOTE** an instance reboot is needed for many changes to take effect, !!! note
you may want to visit `/api/v1/pleroma/admin/restart` on your instance An instance reboot is needed for many changes to take effect,
to soft-restart the instance. you may want to visit `/api/v1/pleroma/admin/restart` on your instance
to soft-restart the instance.

6
docs/docs/configuration/cheatsheet.md
View file

@ -888,7 +888,8 @@ or
curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/v1/pleroma/admin/users/invites" curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/v1/pleroma/admin/users/invites"
``` ```
Warning: it's discouraged to use this feature because of the associated security risk: static / rarely changed instance-wide token is much weaker compared to email-password pair of a real admin user; consider using HTTP Basic Auth or OAuth-based authentication instead. !!! warning
It's discouraged to use this feature because of the associated security risk: static / rarely changed instance-wide token is much weaker compared to email-password pair of a real admin user; consider using HTTP Basic Auth or OAuth-based authentication instead.
### :auth ### :auth
@ -1127,7 +1128,8 @@ meaning that only authenticated users will be able to access the corresponding r
If you'd like to allow unauthenticated access to specific resources, you can turn these settings to `false`. If you'd like to allow unauthenticated access to specific resources, you can turn these settings to `false`.
**Note**: setting `restrict_unauthenticated/timelines/local` to `true` has no practical sense if `restrict_unauthenticated/timelines/federated` is set to `false` (since local public activities will still be delivered to unauthenticated users as part of federated timeline). !!! note
Setting `restrict_unauthenticated/timelines/local` to `true` has no practical sense if `restrict_unauthenticated/timelines/federated` is set to `false` (since local public activities will still be delivered to unauthenticated users as part of federated timeline).
## Pleroma.Web.ApiSpec.CastAndValidate ## Pleroma.Web.ApiSpec.CastAndValidate

3
docs/docs/configuration/how_to_serve_another_domain_for_webfinger.md
View file

@ -27,7 +27,8 @@ This file will indeed contain a URL template of the form `https://example.org/.w
## Configuring your Akkoma instance ## Configuring your Akkoma instance
**_DO NOT ATTEMPT TO CONFIGURE YOUR INSTANCE THIS WAY IF YOU DID NOT UNDERSTAND THE ABOVE_** !!! danger
DO NOT ATTEMPT TO CONFIGURE YOUR INSTANCE THIS WAY IF YOU DID NOT UNDERSTAND THE ABOVE
### Configuring Akkoma ### Configuring Akkoma

3
docs/docs/configuration/i2p.md
View file

@ -15,7 +15,8 @@ One using the config, and one using external software (fedproxy). The external s
### Using the Config ### Using the Config
**Warning:** So far, everytime I followed this way of federating using I2P, the rest of my federation stopped working. I'm leaving this here in case it will help with making it work. !!! warning
So far, everytime I followed this way of federating using I2P, the rest of my federation stopped working. I'm leaving this here in case it will help with making it work.
Assuming you're running in prod, `cd` to your Akkoma folder and append the following to `config/prod.secret.exs`: Assuming you're running in prod, `cd` to your Akkoma folder and append the following to `config/prod.secret.exs`:
``` ```