forked from mirrors/iceshrimp
[docs] Remove search backends from installation docs, example config & example docker-compose.yml
This commit is contained in:
parent
78c5e1dcdb
commit
4c12a8882e
GPG key ID:
D044E84C5BE01605
|
|
@ -72,27 +72,6 @@ redis:
|
|||
#db: 1
|
||||
#user: default
|
||||
|
||||
# Please configure either MeiliSearch *or* Sonic.
|
||||
# If both MeiliSearch and Sonic configurations are present, MeiliSearch will take precedence.
|
||||
|
||||
# ┌───────────────────────────┐
|
||||
#───┘ MeiliSearch configuration └───────────────────────────────
|
||||
#meilisearch:
|
||||
# host: meilisearch
|
||||
# port: 7700
|
||||
# ssl: false
|
||||
# apiKey:
|
||||
|
||||
# ┌─────────────────────┐
|
||||
#───┘ Sonic configuration └─────────────────────────────────────
|
||||
|
||||
#sonic:
|
||||
# host: sonic
|
||||
# port: 1491
|
||||
# auth: SecretPassword
|
||||
# collection: notes
|
||||
# bucket: default
|
||||
|
||||
|
||||
# ┌───────────────┐
|
||||
#───┘ ID generation └───────────────────────────────────────────
|
||||
|
|
|
|||
|
|
@ -72,27 +72,6 @@ redis:
|
|||
#db: 1
|
||||
#user: default
|
||||
|
||||
# Please configure either MeiliSearch *or* Sonic.
|
||||
# If both MeiliSearch and Sonic configurations are present, MeiliSearch will take precedence.
|
||||
|
||||
# ┌───────────────────────────┐
|
||||
#───┘ MeiliSearch configuration └───────────────────────────────
|
||||
#meilisearch:
|
||||
# host: meilisearch
|
||||
# port: 7700
|
||||
# ssl: false
|
||||
# apiKey:
|
||||
|
||||
# ┌─────────────────────┐
|
||||
#───┘ Sonic configuration └─────────────────────────────────────
|
||||
|
||||
#sonic:
|
||||
# host: localhost
|
||||
# port: 1491
|
||||
# auth: SecretPassword
|
||||
# collection: notes
|
||||
# bucket: default
|
||||
|
||||
|
||||
# ┌───────────────┐
|
||||
#───┘ ID generation └───────────────────────────────────────────
|
||||
|
|
|
|||
|
|
@ -18,9 +18,7 @@ git clone https://iceshrimp.dev/iceshrimp/iceshrimp.git
|
|||
|
||||
### docker-compose.yml
|
||||
|
||||
First, run `cp docs/examples/docker-compose.yml docker-compose.yml`, and edit `docker-compose.yml` if
|
||||
- you want to build the image yourself or choose a [different tag](https://iceshrimp.dev/iceshrimp/-/packages/container/iceshrimp/versions), and/or
|
||||
- you want a search engine for better search performance.
|
||||
First, run `cp docs/examples/docker-compose.yml docker-compose.yml`, and edit `docker-compose.yml` if you want to build the image yourself or choose a [different tag](https://iceshrimp.dev/iceshrimp/-/packages/container/iceshrimp/versions)
|
||||
|
||||
### .config
|
||||
|
||||
|
|
@ -28,7 +26,6 @@ Run `cp .config/docker_example.env .config/docker.env`, and edit `.config/docker
|
|||
Run `cp .config/example-docker.yml .config/default.yml`, and edit `.config/default.yml`
|
||||
- Replace example database credentials with the ones you entered in `.config/docker.env`
|
||||
- Change other configuration
|
||||
- Optionally, set up the search backend, if you have chosen to set one up.
|
||||
|
||||
## Installation and first start
|
||||
|
||||
|
|
|
|||
|
|
@ -15,9 +15,6 @@ services:
|
|||
depends_on:
|
||||
- db
|
||||
- redis
|
||||
### Uncomment one of the following to use a search engine
|
||||
# - meilisearch
|
||||
# - sonic
|
||||
ports:
|
||||
- "3000:3000"
|
||||
networks:
|
||||
|
|
@ -49,33 +46,6 @@ services:
|
|||
volumes:
|
||||
- ./db:/var/lib/postgresql/data
|
||||
|
||||
### Search Engines
|
||||
### Only one of the below should be used.
|
||||
### Meilisearch is better overall, but resource-intensive. Sonic is a very light full text search engine.
|
||||
|
||||
# meilisearch:
|
||||
# container_name: iceshrimp_meilisearch
|
||||
# image: docker.io/getmeili/meilisearch:v1.1.1
|
||||
# environment:
|
||||
# - MEILI_ENV=${MEILI_ENV:-development}
|
||||
# ports:
|
||||
# - "7700:7700"
|
||||
# networks:
|
||||
# - ishnet
|
||||
# volumes:
|
||||
# - ./meili_data:/meili_data
|
||||
# restart: unless-stopped
|
||||
|
||||
# sonic:
|
||||
# container_name: iceshrimp_sonic
|
||||
# restart: unless-stopped
|
||||
# image: docker.io/valeriansaliou/sonic:v1.4.0
|
||||
# networks:
|
||||
# - ishnet
|
||||
# volumes:
|
||||
# - ./sonic:/var/lib/sonic/store
|
||||
# - ./sonic/config.cfg:/etc/sonic.cfg
|
||||
|
||||
networks:
|
||||
ishnet:
|
||||
# web:
|
||||
|
|
|
|||
|
|
@ -23,10 +23,6 @@ This document will guide you through manual installation of Iceshrimp. We also p
|
|||
### Optional
|
||||
|
||||
- [**FFmpeg**](https://ffmpeg.org/) for video transcoding
|
||||
- Full text search (Choose one)
|
||||
Iceshrimp has full text search powered by Postgres by default, however it's very slow, and these are alternatives for that
|
||||
- [**Meilisearch**](https://www.meilisearch.com/) | [Installation guide](https://www.meilisearch.com/docs/learn/getting_started/quick_start)
|
||||
- [**Sonic**](https://crates.io/crates/sonic-server) (More lightweight, but less features) | [Installation guide](https://github.com/valeriansaliou/sonic#installation)
|
||||
|
||||
## Preparations
|
||||
|
||||
|
|
@ -50,7 +46,6 @@ Following steps will require you to run them as the user you have made, so use `
|
|||
- Copy `.config/example.yml` to `.config/default.yml`
|
||||
- Edit `.config/default.yml` with text editor
|
||||
- Make sure to set PostgreSQL and Redis section correctly
|
||||
- Make sure to set/uncomment text search sections if you have chosen to set up a search backend
|
||||
|
||||
## Installing project dependencies
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue