]> Untitled Git - lemmy.git/commitdiff
Improve installation docs
authorFelix <me@nutomic.com>
Tue, 31 Mar 2020 00:06:31 +0000 (02:06 +0200)
committerFelix <me@nutomic.com>
Tue, 31 Mar 2020 00:06:31 +0000 (02:06 +0200)
docs/src/administration_install_ansible.md
docs/src/administration_install_docker.md

index 875dae6a12c2152b40c7eda9301ec81d15893052..bf5e674931adcd21e71d4feb88f4b78c008bff1b 100644 (file)
@@ -1,5 +1,7 @@
 # Ansible Installation
 
+This is the same as the [Docker installation](administration_install_docker.md), except that Ansible handles all of it automatically. It also does some extra things like setting up TLS and email for your Lemmy instance.
+
 First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) (e.g. using `sudo apt install ansible`) or the equivalent for you platform.
 
 Then run the following commands on your local computer:
@@ -11,3 +13,10 @@ cp inventory.example inventory
 nano inventory # enter your server, domain, contact email
 ansible-playbook lemmy.yml --become
 ```
+
+To update to a new version, just run the following in your local Lemmy repo:
+```bash
+git pull origin master
+cd ansible
+ansible-playbook lemmy.yml --become
+```
\ No newline at end of file
index 9920498399f8633282b5e76f506b2af11f69c1e9..391299b3d8a799b2d6d5d5a5588f27fb7a0d593f 100644 (file)
@@ -1,29 +1,33 @@
 # Docker Installation
 
-Make sure you have both docker and docker-compose(>=`1.24.0`) installed:
+Make sure you have both docker and docker-compose(>=`1.24.0`) installed. On Ubuntu, just run `apt install docker-compose docker.io`. Next, 
 
 ```bash
-mkdir lemmy/
-cd lemmy/
+# create a folder for the lemmy files. the location doesnt matter, you can put this anywhere you want
+mkdir /lemmy
+cd /lemmy
+# download default config files
 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml
 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/lemmy.hjson
 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/iframely.config.local.js
-# Edit lemmy.hjson, and docker-compose.yml to do more configuration (like adding a custom password)
 docker-compose up -d
 ```
 
-and go to http://localhost:8536.
+After this, have a look at the [config file](administration_configuration.md) named `lemmy.hjson`, and adjust it, in particular the hostname.
 
-[A sample nginx config](/ansible/templates/nginx.conf) (Note: Avatar / Image uploading won't work without this), could be setup with:
+To make Lemmy available outside the server, you need to setup a reverse proxy, like Nginx. [A sample nginx config](/ansible/templates/nginx.conf), could be setup with:
 
 ```bash
 wget https://raw.githubusercontent.com/dessalines/lemmy/master/ansible/templates/nginx.conf
 # Replace the {{ vars }}
 sudo mv nginx.conf /etc/nginx/sites-enabled/lemmy.conf
 ```
+
+You will also need to setup TLS, for example with [Let's Encrypt](https://letsencrypt.org/). After this you need to restart Nginx to reload the config.
+
 ## Updating
 
-To update to the newest version, run:
+To update to the newest version, you can manually change the version in `docker-compose.yml`. Alternatively, fetch the latest version from our git repo:
 
 ```bash
 wget https://raw.githubusercontent.com/dessalines/lemmy/master/docker/prod/docker-compose.yml