README.md 2.03 KB
Newer Older
nono's avatar
nono committed
1
# HedgeDocs Role
nono's avatar
nono committed
2

3
> The purpose of this role is to setup HedgeDocs pad service.
4

5
## Dependencies
6

7
[Official documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/setup/manual-setup.md)
nono's avatar
nono committed
8

9
This service has been designed for Debian GNU/Linux 10.
nono's avatar
nono committed
10

11
1. It will install dependencies required to run the service. You just have to fill variables described just below into your configuration file:
nono's avatar
nono committed
12
13
14
15

- Node.js 10.13+
- PostgreSQL
- NPM
nono's avatar
nono committed
16
17
- Yarn

18
2. Please install postgresql module as well: https://docs.ansible.com/ansible/latest/collections/community/postgresql
19

20
3. You will have to manage SSL configuration on your own by using Let's Encrypt or ZeroSSL. If you don't know the path to save your keys, please have a look to the nginx configuration file.
21

22
## Variables
23

24
Please look at variables from this file `vars/main.yml`
25

nono's avatar
nono committed
26
## Example Playbook
27

nono's avatar
nono committed
28
    - hosts: hedgedocs-server
29
      roles:
nono's avatar
nono committed
30
         - { role: hedgedocs-pad-lqdn,
nono's avatar
nono committed
31
32
33
34
35
36
             hedgedoc_version: "1.7.0-rc2"
             service_hedgedocs_domain : "pad.test.lqdn.fr"
             hedgedoc_db_name : hedgedocs-user
             hedgedoc_db_user : hedgedocs
             hedgedoc_sql_password : "{{ vault_hedgedoc_sql_password }}"
             hedgedoc_session_secret : "{{ vault_hedgedoc_session_secret }}"
nono's avatar
nono committed
37
         }
38

nono's avatar
nono committed
39
40
41
42
43
44
45
46
47
48
49
50
51
52
## Licence

hedgedocs-lqdn
Copyright (C) 2021  nono

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
53

nono's avatar
nono committed
54
55
You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
56

nono's avatar
nono committed
57
## Author Information
58
59
------------------

60
Written by nono <np@laquadrature.net> in 2021, for La Quadrature du Net ( lqdn.fr ).