From e07a719f5183d0e3e4c89188d28660d660f56478 Mon Sep 17 00:00:00 2001 From: Marius Monnier Date: Sat, 5 Dec 2020 23:17:02 +0100 Subject: [PATCH] Fix some typos --- source/contribute/development.html.md | 2 +- source/contribute/feature-request.html.md | 2 +- source/environment.html.md | 6 +++--- source/installation/proxy/caddy.html.md | 12 ++++++++++-- source/installation/with/prebuilt.html.md | 2 +- source/organization/contributors.html.md | 2 +- source/organization/where.html.md | 2 +- source/update/prebuilt.html.md | 2 +- 8 files changed, 19 insertions(+), 11 deletions(-) diff --git a/source/contribute/development.html.md b/source/contribute/development.html.md index 758aba7..5888a99 100644 --- a/source/contribute/development.html.md +++ b/source/contribute/development.html.md @@ -10,7 +10,7 @@ Plume is mostly made in Rust. The back-end uses Rocket and Diesel. The front-end is in Rust too, thanks to WebAssembly. The stylesheets are written in SCSS. If you want to write some code but you don't really know where to start, you -can try to find [an issue that interests you](https://git.joinplu.me/Plume/Plume/issues))([GitHub](https://github.com/Plume-org/Plume/issues)). +can try to find [an issue that interests you](https://git.joinplu.me/Plume/Plume/issues) ([GitHub](https://github.com/Plume-org/Plume/issues)). Then, fork Plume (if you didn't already do it), `git clone` your fork, and start a new branch with `git checkout -b NAME-OF-THE-BRANCH`. You can now start to work on the diff --git a/source/contribute/feature-request.html.md b/source/contribute/feature-request.html.md index ff27b6c..37ed370 100644 --- a/source/contribute/feature-request.html.md +++ b/source/contribute/feature-request.html.md @@ -20,5 +20,5 @@ Then you can open on [Gitea](https://git.joinplu.me/Plume/Plume/issues/new) or [GitHub](https://github.com/Plume-org/Plume/issues/new?template=feature_request.md), if you have an account there. Just fill the information asked in the form, and click "Submit new issue". -If you don't have a GitHub account, you can also suggest your feature in [the Matrix room](/contribute/discussion), and we +If you don't have a Giteat nor GitHub account, you can also suggest your feature in [the Matrix room](/contribute/discussion), and we will create the issue for you. diff --git a/source/environment.html.md b/source/environment.html.md index 4e179c6..161fd36 100644 --- a/source/environment.html.md +++ b/source/environment.html.md @@ -25,8 +25,8 @@ meaning that all your users will get disconnected. You can generate one with `op - `SEARCH_LANG`: the shortcut for the combination of `SEARCH_TAG_TOKENIZER` and `SEARCH_CONTENT_TOKENIZER`. Currently supports only `ja` and it requires `search-lindera` feature on build. This is experimental and might change in the future. Since v0.5.0. - `MEDIA_UPLOAD_DIRECTORY`: the directory in which to store the uploaded medias (`./static/media` by default). Plume won't create this directory if it doesn't exist, so make sure to create it before. - `DEFAULT_THEME`: the name of the default theme. It should be the same as the name of the directory containing the theme in `static/css`. -- `DB_MAX_SIZE`: the maximum number of database connections (`10` by default). Since 0.5.0. -- `DB_MIN_IDLE`: the minimum idle database connection count (the same to `DB_MAX_SIZE` by default). Since 0.5.0. +- `DB_MAX_SIZE`: the maximum number of database connections (`10` by default). Since v0.5.0. +- `DB_MIN_IDLE`: the minimum idle database connection count (the same to `DB_MAX_SIZE` by default). Since v0.5.0. ## Mail @@ -74,7 +74,7 @@ PLUME_LOGO_512=icons/trwnh/paragraphs/plumeParagraphs512.png Plume support delegating authentication via LDAP. - `LDAP_ADDR`: address of the LDAP server - `LDAP_BASE_DN`: base DN used when binding, see explanation below -- `LDAP_USER_NAME_ATTR`: attribut with user name ised when binding, see explanation below (default=`cn`) +- `LDAP_USER_NAME_ATTR`: attribut with user name used when binding, see explanation below (default=`cn`) - `LDAP_USER_MAIL_ATTR`: attribut containing the mail address of the user (default=`mail`) - `LDAP_TLS`: connect to the LDAP server using TLS (default=false) diff --git a/source/installation/proxy/caddy.html.md b/source/installation/proxy/caddy.html.md index 0b52939..fb48bde 100644 --- a/source/installation/proxy/caddy.html.md +++ b/source/installation/proxy/caddy.html.md @@ -2,7 +2,7 @@ title: Configuring Caddy --- -The Caddy configuration is very short. +The Caddy v1 configuration is very short. ``` DOMAIN_NAME { @@ -12,6 +12,14 @@ DOMAIN_NAME { } ``` +The Caddy v2 configuration is shorter. + +``` +DOMAIN_NAME { + reverse_proxy localhost:7878 +} +``` + Don't forget to replace `DOMAIN_NAME` with your own domain. -Restart Caddy, and your Plume instance should be accessible! \ No newline at end of file +Restart Caddy, and your Plume instance should be accessible! diff --git a/source/installation/with/prebuilt.html.md b/source/installation/with/prebuilt.html.md index 60eb3a8..aebdb45 100644 --- a/source/installation/with/prebuilt.html.md +++ b/source/installation/with/prebuilt.html.md @@ -9,7 +9,7 @@ You will need to have `wget` installed for this method to work. To download and install the latest release, first define the following variable in your shell: -- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP or `sqlite` in the file name. Choose which you want. +- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP` or `sqlite` in the file name. Choose which you want. Then run these commands: diff --git a/source/organization/contributors.html.md b/source/organization/contributors.html.md index 32c2b80..47f0b5a 100644 --- a/source/organization/contributors.html.md +++ b/source/organization/contributors.html.md @@ -69,4 +69,4 @@ Skills: ## Want to add yourself here? You can either [do it by yourself](https://git.joinplu.me/plume/documentation/_edit/main/source/organization/contributors.html.md) -if you have a Gitea account, or give Ana all the required informations and she will add you (see above for contact information). +if you have a Gitea account, or give Ana/KitaitiMakoto all the required informations and she/he will add you (see above for contact information). diff --git a/source/organization/where.html.md b/source/organization/where.html.md index dd3964e..3d19620 100644 --- a/source/organization/where.html.md +++ b/source/organization/where.html.md @@ -66,7 +66,7 @@ We publish x86 docker images on Docker Hub. ARM images are hosted by [Lollipop C ## Joining one of these places -We will eventually ask you if you want to be added the Gitea or GitHib organization, as a Crowdin manager, to the Matrix moderators +We will eventually ask you if you want to be added the Gitea or GitHub organization, as a Crowdin manager, to the Matrix moderators or to the authors of *~PlumeDev@fediverse.blog*. If you consider we should add you, you can also ask by yourselve. diff --git a/source/update/prebuilt.html.md b/source/update/prebuilt.html.md index 40f2a62..e29434c 100644 --- a/source/update/prebuilt.html.md +++ b/source/update/prebuilt.html.md @@ -6,7 +6,7 @@ Prebuilt binaries are only available for 64 bits Linux machines. You'll need to define a variable in your shell first: -- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP or `sqlite` in the file name. Choose which you want. +- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP` or `sqlite` in the file name. Choose which you want. Then run these commands: