##// END OF EJS Templates
docs(configuration): added info about turning off elasticsearch
marcink -
Show More
@@ -1,6 +1,6 b''
1 ## BUILD
1 ## BUILD
2 # cd docs
2 # cd docs
3 # docker build --tag sphinx-doc-build .
3 # docker build --tag rhodecode/sphinx-doc-build .
4
4
5 # Build Docs
5 # Build Docs
6 # docker run --rm -v $PWD:/project --workdir=/project/docs sphinx-doc-build make clean html No newline at end of file
6 # docker run --rm -v $PWD:/project --workdir=/project/docs rhodecode/sphinx-doc-build make clean html No newline at end of file
@@ -1,5 +1,24 b''
1 FROM sphinxdoc/sphinx
1 FROM python:3.12.0-bullseye
2
2
3 WORKDIR /project
3 WORKDIR /project
4
5 RUN apt-get update \
6 && apt-get install --no-install-recommends --yes \
7 curl \
8 zip \
9 graphviz \
10 imagemagick \
11 make \
12 && apt-get autoremove \
13 && apt-get clean \
14 && rm -rf /var/lib/apt/lists/*
15
16 RUN \
17 python3 -m pip install --no-cache-dir --upgrade pip && \
18 python3 -m pip install --no-cache-dir Sphinx Pillow
19
4 ADD requirements_docs.txt /project
20 ADD requirements_docs.txt /project
5 RUN pip3 install -r requirements_docs.txt
21 RUN \
22 python3 -m pip install -r requirements_docs.txt
23
24 CMD ["sphinx-build", "-M", "html", ".", "_build"]
@@ -5,3 +5,7 b' sphinx-press-theme==0.8.0'
5 sphinx-rtd-theme==1.3.0
5 sphinx-rtd-theme==1.3.0
6
6
7 pygments==2.16.1
7 pygments==2.16.1
8
9 docutils<0.19
10 markupsafe==2.1.3
11 jinja2==3.1.2
@@ -59,3 +59,53 b' By editing :file:`.custom/docker-compose-services.override.yaml`'
59 # to disable set replicas to 0
59 # to disable set replicas to 0
60 deploy:
60 deploy:
61 replicas: 0
61 replicas: 0
62
63
64 Disable ElasticSearch
65 +++++++++++++++++++++
66
67 ElasticSearch is used by default as a search engine.
68 Elasticsearch is powerful search engine, however it generally requires a lot of resource to be functional.
69
70 In case the plan is to use CE edition, or the machine is restricted with resource ElasticSearch can be disabled.
71
72 By editing :file:`.custom/docker-compose-services.override.yaml`
73
74
75 .. code-block:: yaml
76
77
78 version: '3.9'
79 ## This is a final override file for services stack
80 ## Add your own customizations
81
82 ## set elasticsearch replicas to 0 to stop running it together with services stack.
83 services:
84
85 elasticsearch:
86 # to disable set replicas to 0
87 deploy:
88 replicas: 0
89
90
91 Elasticsearch is used by default as a search engine inside the rhodecode.ini configuration.
92 So this needs to be also adjusted.
93
94
95 By editing :file:`config/_shared/rhodecode.ini`
96
97 Turn of ElasticSearch and enable Whoosh
98
99 .. code-block:: ini
100
101 ; ElasticSearch (EE edition only). Requires Elastic Search cluster
102 ; to be installed, and running. Recommended for large amount of repositories
103 #search.module = rc_elasticsearch
104 #search.location = http://elasticsearch:9200
105 ; specify Elastic Search version, 6 for latest or 2 for legacy
106 #search.es_version = 6
107
108 ; WHOOSH Backend, doesn't require additional services to run
109 ; it works good with few dozen repos
110 search.module = rhodecode.lib.index.whoosh
111 search.location = /var/opt/rhodecode_data/index
General Comments 0
You need to be logged in to leave comments. Login now