Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/confuzeus/ansible-plausible
Setup your Plausible instance in a few minutes.
https://github.com/confuzeus/ansible-plausible
analytics ansible ansible-playbook ansible-role ansible-roles automation debian devops linux plausible-analytics privacy privacy-tools
Last synced: 4 months ago
JSON representation
Setup your Plausible instance in a few minutes.
- Host: GitHub
- URL: https://github.com/confuzeus/ansible-plausible
- Owner: confuzeus
- License: mit
- Created: 2022-02-10T17:31:48.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-20T08:52:29.000Z (almost 3 years ago)
- Last Synced: 2024-09-30T23:04:48.479Z (4 months ago)
- Topics: analytics, ansible, ansible-playbook, ansible-role, ansible-roles, automation, debian, devops, linux, plausible-analytics, privacy, privacy-tools
- Language: Vim script
- Homepage:
- Size: 26.4 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ansible Plausible
Setup your own [Plausible Analytics](https://plausible.io) instance in a few minutes.
Buying a subscription is the easiest way to get started with Plausible but this Ansible
playbook makes it easier for DIYers to self host an instance.
## Requirements
1. A server with Debian 11 installed.
2. A domain name managed at Cloudflare.
3. Your Cloudflare api token.
4. Email address with SMTP access.
## Quick start
Setup your ssh connection first. Edit your `~/.ssh/config` on your local machine like so:
```shell
Host myhostname
HostName 192.168.1.1
User root
IdentitiesOnly yes
```
*HostName* will equal to your server's IP address.
Now you can edit `inventory.yml` to look like this:
```yaml
all:
hosts: myserver
vars:
admin_username: "myusername"
plausible_port: "10000"
```
Make sure to copy your SSH public key to your server and enable passwordless login.
Now, edit the file at `common/vars/main.yml`. Change the values are you see fit.
Rename the file at `common/templates/example.com.conf` and set it to `yourdomain.com.conf`.
Or keep the example template and make a copy of it instead.
Now edit the file at `plausible/vars/main.yml` and set the values as you like.
After having setup all the variables, you can encrypt your variables files like so:
```shell
ansible-vault encrypt common/vars/main.yml
ansible-vault encrypt plausible/vars/main.yml
```
If you encrypt your variables, edit `Makefile` and set `ANSIBLE_ASK_VAULT_PASS` and
`PLAUSIBLE_ASK_VAULT_PASS` to True.
Run `make` and the play should start.
Once the play is complete, your plausible instance should be accessible at *yourdomain.com*.
### Things to note
- Passwords for Linux users must be hashed using `mkpasswd -m sha-512`
## Installing on an existing server
If you already have a server that you use to host other stuff, you should avoid running the
*common* role because it will destroy your Nginx configs and possibly lock you out from SSH.
Instead, run `make plausible` to only install Plausible. You will need to have *docker* and
*docker-compose* installed.
## Support and feature requests
Feel free to request support and features on the Github issue tracker.
## License and Copyright
License is MIT.
Copyright 2022 Josh Michael karamuth