Browse Source

Add documentation about SEARCH_TAG_TOKENIZER, SEARCH_CONTENT_TOKENIZER

and/or SEARCH_LANG
search-config
Kitaiti Makoto 10 months ago
parent
commit
7305b4c663
2 changed files with 12 additions and 0 deletions
  1. +3
    -0
      source/environment.html.md
  2. +9
    -0
      source/installation/with/source-code.html.md

+ 3
- 0
source/environment.html.md View File

@@ -18,6 +18,9 @@ Here are the variables that Plume uses:
- `ROCKET_SECRET_KEY`: key used to sign private cookies and for CSRF protection. If it is not set, it will be regenerated everytime you restart Plume,
meaning that all your users will get disconnected. You can generate one with `openssl rand -base64 32`.
- `SEARCH_INDEX`: the directory where the search index will be saved (`search_index` by default).
- `SEARCH_TAG_TOKENIZER`: the tokenizer used for tags when searching. `simple`, `ngram`, `whitespace` and `lindera` are available. `simple` tokenizer tokenizes the text by splitting on whitespaces and punctuation. `ngram` tokenizes by splitting words into bigram at a minimum and 8-gram at a maximum. `whitespace` tokenizes by splitting on whitespaces but not on punctuation. `lindera` tokenizes the text by splitting into Japanese morpheme, which is available only when build with `search-lindera` feature. `whitespace` by default. Since v0.5.0.
- `SEARCH_CONTENT_TOKENIZER`: the tokenizer used for blog contents when searching. The same tokenizers to `SEARCH_TAG_TOKENIZER` are available. `simple` by default. Since v0.5.0.
- `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.


+ 9
- 0
source/installation/with/source-code.html.md View File

@@ -28,6 +28,15 @@ cargo install --no-default-features --features DATABASE --path plume-cli

```

Since v0.5.0, Plume supports [Lindera](https://github.com/lindera-morphology/lindera), a Japanese morphological analysis library for Japanese search. If you want to use it, pass `search-lindera` to `--features` option to build both plume and plume-cli:

```bash
cargo install --no-default-features --features DATABASE,search-lindera
cargo install --no-default-features --features DATABASE,search-lindera --path plume-cli
```

And then, you can configure Plume by `SEARCH_TAG_TOKENIZER`, `SEARCH_CONTENT_TOKENIZER` and/or `SEARCH_LANG` environment variables. See [Useful Environment Variables](/environment/) for details.

For **Windows**, if you are going to use SQLite, launch an additional cmd.exe as admin and do the following:

```


Loading…
Cancel
Save