From 2256d28850ab0d3d4f477ceeb2cf8a97db49fbe4 Mon Sep 17 00:00:00 2001 From: Craig Oates Date: Fri, 18 Nov 2022 19:15:09 +0000 Subject: [PATCH] update README.org file. --- README.org | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/README.org b/README.org index 7751e55..8bcd817 100644 --- a/README.org +++ b/README.org @@ -129,3 +129,59 @@ This section builds on the one above (running on local machine). The main difference is getting the system to run on Nginx and as a Systemd service. + + The first thing to do is replace the parts which say ~~ + and ~~ in the files in =/conf=. Those values are specific to + your deployment environment. At the time of writing, there should be four + files in =/conf=. They are: + + 1. =meilisearch.conf= (the config. file for Nginx) + 2. =meilisearch.service= (the .service file for Systemd) + 3. =ritherdon-archive.conf= (the config. file for Nginx) + 4. =ritherdon-archive.conf= (the .service file for Systemd) + + After you have entered your details into the =.conf= and =.service= files, + you can start to copy the files into their new locations. + +** Set-Up Meilisearch + + #+begin_src bash + # Nginx + sudo cp ~/ritherdon-archive/conf/meilisearch-prod.conf \ + /etc/nginx/sites-available/meilisearch-prod.conf + sudo ln -s /etc/nginx/sites-available/meilisearch.conf \ + /etc/nginx/sites-enabled/ + sudo systemctl restart nginx.service + + #Systemd + sudo cp ~/ritherdon-archive/conf/meilisearch.service \ + /etc/systemd/system/meilisearch.service + sudo systemctl daemon-reload + sudo systemctl enable meilisearch.service + sudo systemctl status meilisearch.service + #+end_src + +** Set-Up Ritherdon Archive (Main Site) + + #+begin_src bash + # Nginx + sudo cp ~/ritherdon-archive/conf/ritherdon-archive.conf \ + /etc/nginx/sites-available/ritherdon-archive.conf + sudo ln -s /etc/nginx/sites-available/ritherdon-archive.conf \ + /etc/nginx/sites-enabled/ + sudo systemctl restart nginx.service + + #Systemd + sudo cp ~/ritherdon-archive/conf/ritherdon-archive.service \ + /etc/systemd/system/ritherdon-archive.service + sudo systemctl daemon-reload + sudo systemctl enable ritherdon-archive.service + sudo systemctl status ritherdon-archive.service + #+end_src + +* A Note on Using Ritherdon Archive + + This README has focused only on the developer side of the project. This is + deliberate. I just haven't had the time to write any documentation on that + side of the site or is the budget there to do so. Hopefully, this will change + but at the time of writing (Nov. 2022), there is nothing in the repo's wiki.