From 4d3fc9f62b42949cc5e347c9c84cfd53d61dae6f Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Fri, 7 Apr 2023 08:01:51 +0100 Subject: [PATCH] Fix capitalization for Elasticsearch (#1019) --- content/en/admin/config.md | 10 +++---- content/en/admin/optional/elasticsearch.md | 24 ++++++++-------- content/en/admin/tootctl.md | 2 +- content/zh-cn/admin/config.md | 2 +- content/zh-cn/admin/optional/elasticsearch.md | 28 +++++++++---------- content/zh-cn/admin/tootctl.md | 2 +- 6 files changed, 34 insertions(+), 34 deletions(-) diff --git a/content/en/admin/config.md b/content/en/admin/config.md index 2f22fd7b..337d9f5b 100644 --- a/content/en/admin/config.md +++ b/content/en/admin/config.md @@ -360,21 +360,21 @@ Defaults to value of `REDIS_NAMESPACE`. #### `SIDEKIQ_REDIS_URL` -### ElasticSearch {#elasticsearch} +### Elasticsearch {#elasticsearch} {{< page-ref page="admin/optional/elasticsearch" >}} #### `ES_ENABLED` -If set to `true`, Mastodon will use ElasticSearch for its search functions. +If set to `true`, Mastodon will use Elasticsearch for its search functions. #### `ES_HOST` -Host of the ElasticSearch server. Defaults to `localhost` +Host of the Elasticsearch server. Defaults to `localhost` #### `ES_PORT` -Port of the ElasticSearch server. Defaults to `9200` +Port of the Elasticsearch server. Defaults to `9200` #### `ES_USER` @@ -386,7 +386,7 @@ Used for optionally authenticating with ElasticSearch #### `ES_PREFIX` -Useful if the ElasticSearch server is shared between multiple projects or different Mastodon servers. Defaults to value of `REDIS_NAMESPACE`. +Useful if the Elasticsearch server is shared between multiple projects or different Mastodon servers. Defaults to value of `REDIS_NAMESPACE`. ### StatsD {#statsd} diff --git a/content/en/admin/optional/elasticsearch.md b/content/en/admin/optional/elasticsearch.md index e6c52bf6..769736ee 100644 --- a/content/en/admin/optional/elasticsearch.md +++ b/content/en/admin/optional/elasticsearch.md @@ -1,30 +1,30 @@ --- title: Full-text search -description: Setting up ElasticSearch to search for statuses authored, favourited, or mentioned in. +description: Setting up Elasticsearch to search for statuses authored, favourited, or mentioned in. menu: docs: weight: 10 parent: admin-optional --- -Mastodon supports full-text search when ElasticSearch is available. Mastodon’s full-text search allows logged in users to find results from their own statuses, their mentions, their favourites, and their bookmarks. It deliberately does not allow searching for arbitrary strings in the entire database. +Mastodon supports full-text search when Elasticsearch is available. Mastodon’s full-text search allows logged in users to find results from their own statuses, their mentions, their favourites, and their bookmarks. It deliberately does not allow searching for arbitrary strings in the entire database. -## Installing ElasticSearch {#install} +## Installing Elasticsearch {#install} -ElasticSearch requires a Java runtime. If you don’t have Java already installed, do it now. Assuming you are logged in as `root`: +Elasticsearch requires a Java runtime. If you don’t have Java already installed, do it now. Assuming you are logged in as `root`: ```bash apt install openjdk-17-jre-headless ``` -Add the official ElasticSearch repository to apt: +Add the official Elasticsearch repository to apt: ```bash wget -O /usr/share/keyrings/elasticsearch.asc https://artifacts.elastic.co/GPG-KEY-elasticsearch echo "deb [signed-by=/usr/share/keyrings/elasticsearch.asc] https://artifacts.elastic.co/packages/7.x/apt stable main" > /etc/apt/sources.list.d/elastic-7.x.list ``` -Now you can install ElasticSearch: +Now you can install Elasticsearch: ```bash apt update @@ -32,14 +32,14 @@ apt install elasticsearch ``` {{< hint style="warning" >}} -**Security warning:** By default, ElasticSearch is supposed to bind to localhost only, i.e. be inaccessible from the outside network. You can check which address ElasticSearch binds to by looking at `network.host` within `/etc/elasticsearch/elasticsearch.yml`. Consider that anyone who can access ElasticSearch can access and modify any data within it, as there is no authentication layer. So it’s really important that the access is secured. Having a firewall that only exposes the 22, 80 and 443 ports is advisable, as outlined in the [main installation instructions](../../prerequisites/#install-a-firewall-and-only-whitelist-ssh-http-and-https-ports). If you have a multi-host setup, you must know how to secure internal traffic. +**Security warning:** By default, Elasticsearch is supposed to bind to localhost only, i.e. be inaccessible from the outside network. You can check which address Elasticsearch binds to by looking at `network.host` within `/etc/elasticsearch/elasticsearch.yml`. Consider that anyone who can access Elasticsearch can access and modify any data within it, as there is no authentication layer. So it’s really important that the access is secured. Having a firewall that only exposes the 22, 80 and 443 ports is advisable, as outlined in the [main installation instructions](../../prerequisites/#install-a-firewall-and-only-whitelist-ssh-http-and-https-ports). If you have a multi-host setup, you must know how to secure internal traffic. {{< /hint >}} {{< hint style="danger" >}} -**Security warning:** ElasticSearch versions between `2.0` and `2.14.1` are affected by an [exploit](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228) in the `log4j` library. If affected, please refer to the [temporary mitigation](https://github.com/elastic/elasticsearch/issues/81618#issuecomment-991000240) from the ElasticSearch issue tracker. +**Security warning:** Elasticsearch versions between `2.0` and `2.14.1` are affected by an [exploit](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228) in the `log4j` library. If affected, please refer to the [temporary mitigation](https://github.com/elastic/elasticsearch/issues/81618#issuecomment-991000240) from the Elasticsearch issue tracker. {{< /hint >}} -To start ElasticSearch: +To start Elasticsearch: ```bash systemctl daemon-reload @@ -56,7 +56,7 @@ ES_HOST=localhost ES_PORT=9200 ``` -If you have multiple Mastodon servers on the same machine, and you are planning to use the same ElasticSearch installation for all of them, make sure that all of them have unique `REDIS_NAMESPACE` in their configurations, to differentiate the indices. If you need to override the prefix of the ElasticSearch indices, you can set `ES_PREFIX` directly. +If you have multiple Mastodon servers on the same machine, and you are planning to use the same Elasticsearch installation for all of them, make sure that all of them have unique `REDIS_NAMESPACE` in their configurations, to differentiate the indices. If you need to override the prefix of the Elasticsearch indices, you can set `ES_PREFIX` directly. After saving the new configuration, restart Mastodon processes for it to take effect: @@ -65,7 +65,7 @@ systemctl restart mastodon-sidekiq systemctl reload mastodon-web ``` -Now it's time to create the ElasticSearch indices and fill them with data: +Now it's time to create the Elasticsearch indices and fill them with data: ```bash su - mastodon @@ -76,7 +76,7 @@ RAILS_ENV=production bin/tootctl search deploy ## Search optimization for other languages ### Chinese search optimization {#chinese-search-optimization} -The default analyzer of the ElasticSearch is the standard analyzer, which may not be the best especially for Chinese. To improve search experience, you can install a language specific analyzer. Before creating the indices in ElasticSearch, install the following ElasticSearch extensions: +The default analyzer of the Elasticsearch is the standard analyzer, which may not be the best especially for Chinese. To improve search experience, you can install a language specific analyzer. Before creating the indices in Elasticsearch, install the following Elasticsearch extensions: - [elasticsearch-analysis-ik](https://github.com/medcl/elasticsearch-analysis-ik) - [elasticsearch-analysis-stconvert](https://github.com/medcl/elasticsearch-analysis-stconvert) diff --git a/content/en/admin/tootctl.md b/content/en/admin/tootctl.md index f7abf490..f06a21ab 100644 --- a/content/en/admin/tootctl.md +++ b/content/en/admin/tootctl.md @@ -790,7 +790,7 @@ Remove local thumbnails for preview cards. ### `tootctl search deploy` {#search-deploy} -Create or update an ElasticSearch index and populate it. If ElasticSearch is empty, this command will create the necessary indices and then import data from the database into those indices. This command will also upgrade indices if the underlying schema has been changed since the last run. +Create or update an Elasticsearch index and populate it. If Elasticsearch is empty, this command will create the necessary indices and then import data from the database into those indices. This command will also upgrade indices if the underlying schema has been changed since the last run. `--batch-size` : Defaults to 1000. A lower batch size can make ElasticSearch process records more quickly. diff --git a/content/zh-cn/admin/config.md b/content/zh-cn/admin/config.md index 0b1e78c2..ecc07478 100644 --- a/content/zh-cn/admin/config.md +++ b/content/zh-cn/admin/config.md @@ -92,7 +92,7 @@ Mastodon使用环境变量作为其的配置。 * `CACHE_REDIS_URL` * `CACHE_REDIS_NAMESPACE` -### ElasticSearch {#elasticsearch} +### Elasticsearch {#elasticsearch} * `ES_ENABLED` * `ES_HOST` diff --git a/content/zh-cn/admin/optional/elasticsearch.md b/content/zh-cn/admin/optional/elasticsearch.md index 140ec46c..1777440f 100644 --- a/content/zh-cn/admin/optional/elasticsearch.md +++ b/content/zh-cn/admin/optional/elasticsearch.md @@ -1,23 +1,23 @@ --- title: 全文搜索 -description: 设置ElasticSearch来搜索自己发出的嘟文、自己喜欢的嘟文、自己的书签和自己被提及的嘟文。 +description: 设置Elasticsearch来搜索自己发出的嘟文、自己喜欢的嘟文、自己的书签和自己被提及的嘟文。 menu: docs: weight: 10 parent: admin-optional --- -当有可用ElasticSearch时，Mastodon支持全文搜索。Mastodon的全文搜索允许登录用户从他们自己的嘟文、他们喜欢的嘟文、他们的书签和他们被提及的嘟文中查找相应结果。Mastodon有意禁用了在全数据库搜索任意关键词的功能。 +当有可用Elasticsearch时，Mastodon支持全文搜索。Mastodon的全文搜索允许登录用户从他们自己的嘟文、他们喜欢的嘟文、他们的书签和他们被提及的嘟文中查找相应结果。Mastodon有意禁用了在全数据库搜索任意关键词的功能。 -## 安装 ElasticSearch {#install} +## 安装 Elasticsearch {#install} -ElasticSearch 需要 Java runtime。如果你还没有安装 Java，请立刻安装上它。以下操均假定你已经登录为`root`用户： +Elasticsearch 需要 Java runtime。如果你还没有安装 Java，请立刻安装上它。以下操均假定你已经登录为`root`用户： ```bash apt install openjdk-8-jre-headless ``` -添加ElasticSearch官方软件仓库至apt： +添加Elasticsearch官方软件仓库至apt： ```bash wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | apt-key add - @@ -25,20 +25,20 @@ echo "deb https://artifacts.elastic.co/packages/6.x/apt stable main" | tee -a /e apt update ``` -现在，你可以安装 ElasticSearch： +现在，你可以安装 Elasticsearch： ```bash apt install elasticsearch ``` {{< hint style="warning" >}} -**安全警告：** 默认情况下，ElasticSearch仅绑定于localhost，即无法从外部网络访问。你可以通过查看 `/etc/elasticsearch/elasticsearch.yml` 中的 `network.host` 来检查 ElasticSearch 绑定了哪些地址。考虑到由于缺乏认证层，任何能访问 ElasticSearch 的人都可以读取或修改里面的数据。因此，确保访问安全非常重要。如[主要安装说明](../../prerequisites/#install-a-firewall-and-only-whitelist-ssh-http-and-https-ports)中所述，防火墙建议仅暴露了22、80、443端口。如果你是一个多主机配置，你必须知道如何保证内部流量安全。 +**安全警告：** 默认情况下，Elasticsearch仅绑定于localhost，即无法从外部网络访问。你可以通过查看 `/etc/elasticsearch/elasticsearch.yml` 中的 `network.host` 来检查 Elasticsearch 绑定了哪些地址。考虑到由于缺乏认证层，任何能访问 Elasticsearch 的人都可以读取或修改里面的数据。因此，确保访问安全非常重要。如[主要安装说明](../../prerequisites/#install-a-firewall-and-only-whitelist-ssh-http-and-https-ports)中所述，防火墙建议仅暴露了22、80、443端口。如果你是一个多主机配置，你必须知道如何保证内部流量安全。 {{< /hint >}} {{< hint style="danger" >}} -**安全警告:** 由于近期ElasticSearch所使用的`log4j`库被披露出[安全漏洞](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228)，使用了旧版本`log4j`(`2.0`到`2.14.1`)的ES可能会受到影响。如果使用了这些版本的`log4j`，请参阅 [此 issue](https://github.com/elastic/elasticsearch/issues/81618#issuecomment-991000240) 来暂时缓解此问题。 +**安全警告:** 由于近期Elasticsearch所使用的`log4j`库被披露出[安全漏洞](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228)，使用了旧版本`log4j`(`2.0`到`2.14.1`)的ES可能会受到影响。如果使用了这些版本的`log4j`，请参阅 [此 issue](https://github.com/elastic/elasticsearch/issues/81618#issuecomment-991000240) 来暂时缓解此问题。 {{< /hint >}} -启动 ElasticSearch： +启动 Elasticsearch： ```bash systemctl enable elasticsearch @@ -55,10 +55,10 @@ ES_HOST=localhost ES_PORT=9200 ``` -如果你同一台机器上运行多个Mastodon服务器，你计划让它们使用同一个ElasticSearch，请确保他们都配置了互不重复的 `REDIS_NAMESPACE` 以分别他们的索引。如果你需要覆盖ElasticSearch索引前缀，你可以直接设置 `ES_PREFIX`。 +如果你同一台机器上运行多个Mastodon服务器，你计划让它们使用同一个Elasticsearch，请确保他们都配置了互不重复的 `REDIS_NAMESPACE` 以分别他们的索引。如果你需要覆盖Elasticsearch索引前缀，你可以直接设置 `ES_PREFIX`。 -保存新设置之后，使用如下命令创建ElasticSearch索引： +保存新设置之后，使用如下命令创建Elasticsearch索引： ```bash RAILS_ENV=production bundle exec rake chewy:upgrade @@ -71,7 +71,7 @@ systemctl restart mastodon-sidekiq systemctl reload mastodon-web ``` -现在，新的嘟文将会被写入ElasticSearch索引。最后一步是导入所有旧有数据。这将花费很长一段时间： +现在，新的嘟文将会被写入Elasticsearch索引。最后一步是导入所有旧有数据。这将花费很长一段时间： ```bash RAILS_ENV=production bundle exec rake chewy:sync @@ -85,10 +85,10 @@ RAILS_ENV=production bundle exec rake chewy:sync ### 中文搜索优化 {#chinese-search-optimize} -ElasticSearch默认使用标准分析器，这对于中文来说可能并不太适合。为了提高搜索体验，你可以安装特定语言的专用分析器。在创建ElasticSearch索引之前执行： +Elasticsearch默认使用标准分析器，这对于中文来说可能并不太适合。为了提高搜索体验，你可以安装特定语言的专用分析器。在创建Elasticsearch索引之前执行： -安装 [elasticsearch-analysis-ik](https://github.com/medcl/elasticsearch-analysis-ik)、[elasticsearch-analysis-stconvert](https://github.com/medcl/elasticsearch-analysis-stconvert) 插件至 ElasticSearch。 +安装 [elasticsearch-analysis-ik](https://github.com/medcl/elasticsearch-analysis-ik)、[elasticsearch-analysis-stconvert](https://github.com/medcl/elasticsearch-analysis-stconvert) 插件至 Elasticsearch。 并对源码做出如下修改： diff --git a/content/zh-cn/admin/tootctl.md b/content/zh-cn/admin/tootctl.md index d0db014e..bd29300d 100644 --- a/content/zh-cn/admin/tootctl.md +++ b/content/zh-cn/admin/tootctl.md @@ -413,7 +413,7 @@ RAILS_ENV=production bin/tootctl help ### `tootctl search deploy` {#search-deploy} -创建或更新ElasticSearch索引并进行填充。 如果ElasticSearch为空，此命令将创建必要的索引，然后将数据从数据库导入到这些索引中。如果自上次运行以来索引结构已更改，此命令还将升级索引。 +创建或更新Elasticsearch索引并进行填充。 如果Elasticsearch为空，此命令将创建必要的索引，然后将数据从数据库导入到这些索引中。如果自上次运行以来索引结构已更改，此命令还将升级索引。 **版本历史：** * 2.8.0 - 被加入