From 990987b1742fced9ab224d92808a9aa8de0e2526 Mon Sep 17 00:00:00 2001 From: Dessalines Date: Sun, 4 Oct 2020 08:42:30 -0500 Subject: [PATCH] Improving administration page docs. Fixes #1160 --- docs/src/administration.md | 12 ++++++++++-- docs/src/administration_install_docker.md | 6 ++++++ 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/src/administration.md b/docs/src/administration.md index 9851232d9..690b71596 100644 --- a/docs/src/administration.md +++ b/docs/src/administration.md @@ -1,3 +1,11 @@ -# Admin info +# Administration info -Information for Lemmy instance admins, and those who want to start an instance. +Information for Lemmy instance admins, and those who want to run a server. + +## Install + +Lemmy has two primary install methods, [docker](administration_install_docker.md), and [ansible](administration_install_ansible.md). Ansible simplifies deploying to a remote server, while docker is best for local testing. + +### Manual install + +Manual installs are *possible*, but not preferred, since Lemmy is dependent on other local services: The [lemmy-ui](https://github.com/LemmyNet/lemmy-ui), [a Postgresql Database](https://www.postgresql.org/), [pict-rs](https://git.asonix.dog/asonix/pict-rs/) for images, and [iframely](https://iframely.com/) for embeds. To see how these are wired together, look at the docker-compose.yml files. Due to the complexity of different systems, we will not support manual installs. diff --git a/docs/src/administration_install_docker.md b/docs/src/administration_install_docker.md index 311655a36..490fe1c01 100644 --- a/docs/src/administration_install_docker.md +++ b/docs/src/administration_install_docker.md @@ -25,15 +25,21 @@ Open up your `docker-compose.yml`, and make sure `LEMMY_EXTERNAL_HOST` for `lemm - LEMMY_HTTPS=false ``` +If you'd like a different database password, you should also change it in the `docker-compose.yml` **before** your first run. + After this, have a look at the [config file](administration_configuration.md) named `lemmy.hjson`, and adjust it, in particular the hostname, and possibly the db password. Then run: `docker-compose up -d` +You can access the lemmy-ui at `http://localhost:1235` + To make Lemmy available outside the server, you need to setup a reverse proxy, like Nginx. [A sample nginx config](https://raw.githubusercontent.com/LemmyNet/lemmy/main/ansible/templates/nginx.conf), could be setup with: ```bash wget https://raw.githubusercontent.com/LemmyNet/lemmy/main/ansible/templates/nginx.conf # Replace the {{ vars }} +# The default lemmy_port is 8536 +# The default lemmy_ui_port is 1235 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf ```