]> Untitled Git - lemmy.git/commitdiff
Improving administration page docs. Fixes #1160
authorDessalines <tyhou13@gmx.com>
Sun, 4 Oct 2020 13:42:30 +0000 (08:42 -0500)
committerDessalines <tyhou13@gmx.com>
Sun, 4 Oct 2020 13:42:30 +0000 (08:42 -0500)
docs/src/administration.md
docs/src/administration_install_docker.md

index 9851232d9e74b46d63e530551100cdfd864c07f2..690b71596e6f594a0f2ad94f904c529f4ffb0147 100644 (file)
@@ -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.
index 311655a36a10779498eb90bedd3b49be8bf840e6..490fe1c01034023793c88beead6488132e52923d 100644 (file)
@@ -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
 ```