Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LemmyNet/lemmy-ansible
A docker deploy for ansible
https://github.com/LemmyNet/lemmy-ansible
Last synced: 9 days ago
JSON representation
A docker deploy for ansible
- Host: GitHub
- URL: https://github.com/LemmyNet/lemmy-ansible
- Owner: LemmyNet
- License: agpl-3.0
- Created: 2021-10-08T22:29:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T11:56:39.000Z (7 months ago)
- Last Synced: 2024-04-14T00:49:22.856Z (7 months ago)
- Language: Jinja
- Size: 190 KB
- Stars: 244
- Watchers: 9
- Forks: 91
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-lemmy - lemmy-ansible - ansible)  (Projects / Lemmy)
README
# Lemmy-Ansible
This provides an easy way to install [Lemmy](https://github.com/LemmyNet/lemmy) on any server. It automatically sets up an nginx server, letsencrypt certificates, docker containers, pict-rs, and email smtp.
## Requirements
To run this ansible playbook, you need to:
- Have a Debian/AlmaLinux 9-based server / VPS where lemmy will run.
- Supported CPU architectures are x86-64 and ARM64.
- Configure a DNS `A` Record to point at your server's IP address.
- Make sure you can ssh to it, with a sudo user: `ssh @`
- Install [Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) (>= `2.11.0` on your **local** machine (do not install it on your destination server).
### Supported Distribution Playbook Matrix
These are the distributions we currently support. Anything not listed here is currently not supported.
If you wish to see another distribution on the list, please test on the latest commit in `main` and report your findings via an Issue.
| Distribution | Version | Playbook |
| ------------ | --------- | --------------------- |
| Debian | 10 | `lemmy.yml` |
| Debian | 11 | `lemmy.yml` |
| Debian | 12 | `lemmy.yml` |
| Ubuntu | 22.04 LTS | `lemmy.yml` |
| RHEL | 9 | `lemmy-almalinux.yml` |
## Install
1. Clone this repo & checkout latest tag
```
git clone https://github.com/LemmyNet/lemmy-ansible.git
cd lemmy-ansible
git checkout $(git describe --tags)
```
2. Make a directory to hold your config:
`mkdir -p inventory/host_vars/`
3. Copy the sample configuration file:
`cp examples/config.hjson inventory/host_vars//config.hjson`
Edit that file and change the config to your liking. Note: **Do not edit anything inside the {{ }} braces.**
[Here are all the config options.](https://join-lemmy.org/docs/en/administration/configuration.html#full-config-with-default-values)
4. Copy the sample inventory hosts file:
`cp examples/hosts inventory/hosts`
Edit the inventory hosts file (inventory/hosts) to your liking.
5. Copy the sample postgresql.conf
`cp examples/customPostgresql.conf inventory/host_vars//customPostgresql.conf`
You can use [the PGTune tool](https://pgtune.leopard.in.ua) to tune your postgres to meet your server memory and CPU.
6. Copy the sample `vars.yml` file
`cp examples/vars.yml inventory/host_vars//vars.yml`
Edit the `inventory/host_vars//vars.yml` file to your liking.
7. Run the playbook:
_Note_: See the "Supported Distribution Playbook Matrix" section above if you should use `lemmy.yml` or not
`ansible-playbook -i inventory/hosts lemmy.yml`
_Note_: if you are not the root user or don't have password-less sudo, use this command:
`ansible-playbook -i inventory/hosts lemmy.yml --become --ask-become-pass`
_Note_: if you haven't set up ssh keys[^1], and ssh using a password, use the command:
`ansible-playbook -i inventory/hosts lemmy.yml --become --ask-pass --ask-become-pass`
[Full ansible command-line docs](https://docs.ansible.com/ansible/latest/cli/ansible-playbook.html)
If the command above fails, you may need to comment out this line In the ansible.cfg file:
`interpreter_python=/usr/bin/python3`
[^1]: To create an ssh key pair with your host environment, you can follow the [instructions here](https://www.ssh.com/academy/ssh/keygen#copying-the-public-key-to-the-server), and then copy the key to your host server.
## Upgrading
Please see the dedicated [UPGRADING](UPGRADING.md) document for all upgrade processess
Since version `1.1.0` we no longer default to using `main` but use tags to make sure deployments are versioned.
With every new release all migration steps shall be written in the [UPGRADING](UPGRADING.md) document.
When updating please make sure you check out the [Lemmy Releases Changelog](https://github.com/LemmyNet/lemmy/blob/main/RELEASES.md) to see if there are any config changes with the releases since your last read.
## Migrating your existing install to use this deploy
- [Follow this guide](https://join-lemmy.org/docs/en/administration/backup_and_restore.html) to backup your existing install.
- Run `docker-compose stop` to stop lemmy.
- Move your docker folders on the server to `/`.
- Copy your postgres password to `inventory/host_vars//passwords/postgres`.
- Follow the install guide above, making sure your `config.hjson` is the same as your backup.
## Uninstall
`ansible-playbook -i inventory/hosts uninstall.yml --become`
## License
- [AGPL License](/LICENSE)