Compare commits

...

8 commits

Author SHA1 Message Date
jorge 55d81f1d9d service as 2021-05-19 16:34:56 +02:00
jorge 4d7f7dba72 howto install behind a reverse proxy 2021-05-19 15:57:23 +02:00
jorge d9a2cf7549
typo error in README 2021-05-19 13:54:17 +02:00
jorge b58769ef62
added Debian installation explanation in README 2021-05-19 13:53:15 +02:00
Kailash Nadh ea92e8b12e Merge branch 'master' of github.com:knadh/listmonk 2021-05-18 16:17:10 +05:30
Kailash Nadh 9f2e708798 Wrap lines in <pre> without overflowing the viewport.
Closes .
2021-05-18 16:16:28 +05:30
Kailash Nadh 0e5cd6043f
Delete feature---change-request.md 2021-05-17 20:05:39 +05:30
Kailash Nadh 89481edd11 Update issue templates 2021-05-17 20:04:49 +05:30
5 changed files with 130 additions and 5 deletions

18
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,18 @@
---
name: Bug report
about: Report a bug or a problem
title: ''
labels: bug
assignees: ''
---
**Version:**
- listmonk: [eg: v1.0.0]
- OS: [e.g. Fedora]
**Description of the bug and steps to reproduce:**
A clear and concise description of what the bug is.
**Screenshots:**
If applicable, add screenshots to help explain your problem.

View file

@ -0,0 +1,14 @@
---
name: Feature or change request
about: Suggest new features or changes to existing features
title: ''
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.

10
.github/ISSUE_TEMPLATE/general.md vendored Normal file
View file

@ -0,0 +1,10 @@
---
name: General
about: General questions and discussions
title: ''
labels: ''
assignees: ''
---

View file

@ -32,12 +32,90 @@ More information on [docs](https://listmonk.app/docs).
__________________
### Binary
- Download the [latest release](https://github.com/knadh/listmonk/releases) and extract the listmonk binary.
- `./listmonk --new-config` to generate config.toml. Then, edit the file.
- `./listmonk --install` to setup the Postgres DB (or `--upgrade` to upgrade an existing DB. Upgrades are idempotent and running them multiple times have no side effects).
- Run `./listmonk` and visit `http://localhost:9000`.
__________________
#### prerequisites Debian: system user and PostgreSQL
- install `sudo`
- install PostgreSQL `apt install postgresql`
- --create system user with config.toml data for the database:
`adduser listmonkuser`--
- create the postgreSQL database, the user and grant permissions:
`su - postgres` and then acces de PostgreSQL console `psql`
```
postgres=# CREATE DATABASE listmonkdatabase;
postgres=# CREATE USER listmonkuser WITH PASSWORD 'listmonkpassword';
postgres=# GRANT ALL PRIVILEGES ON DATABASE listmonkdatabase TO listmonkuser;
```
#### download an prepare config file
- `cd /var/www/` and make the directory `mkdir listmonk`
- `cd listmonk`
- Download the [latest release](https://github.com/knadh/listmonk/releases) and extract the listmonk binary.
```
wget https://github.com/knadh/listmonk/releases/download/v1.0.0/listmonk_1.0.0_linux_amd64.tar.gz
wget https://github.com/knadh/listmonk/releases/download/v1.0.0/listmonk_1.0.0_checksums.txt
sha256sum listmonk_1.0.0_linux_amd64.tar.gz
cat listmonk_1.0.0_checksums.txt |grep linux
```
- change ownership of files `chown -R www-data:www-data /var/www/listmonk`
- generate config file `sudo -u www-data ./listmonk --new-config`
- edit the config file with the data we created previously and more options `vim /var/www/listmonk/confif.toml`
#### reverse proxy
- create the apache config to work behind a reverse proxy `/etc/apache2/sites-available/listmonk.doamain.tdl.conf`
```
<VirtualHost *:80>
ServerName listmonk.domain.tdl
ServerSignature Off
ErrorLog /var/log/apache2/listmonk.domain.tdl_error.log
TransferLog /var/log/apache2/listmonk.domain.tdl_access.log
LogLevel warn
ProxyPreserveHost On
ProxyPass "/" "http://127.0.0.1:9000/"
ProxyPassReverse "/" "http://127.0.0.1:9000/"
</VirtualHost>
```
- enable the proxy module `a2enmod proxy_http` enable the site `a2ensite listmonk.domain.tdl` and restart apache `systemctl reload apache2`
#### proceed to install
- `sudo -u www-data ./listmonk --install` to setup the Postgres DB (or `--upgrade` to upgrade an existing DB. Upgrades are idempotent and running them multiple times have no side effects).
- Run `sudo -u www-data ./listmonk` and visit `http://listmonk.domain.tdl`
#### after install, fine tunning
oncen checked it works, stop the process.
- move the files to where you like most, usually `/opt/listmonk/` or inside `/var/www/html/`
- change ownership of the files to `www-data` or whatever user you have assigned the webserver `chown -R www-data:www-data listmonk`
- run listmonk as a service, create `/etc/systemd/system/listmonk.service` with:
```
[Unit]
Description=Listmonk domain.tdl server
After=syslog.target network.target postgressql.target
[Service]
Type=simple
# the user and group executing the service
User=www-data
Group=www-data
# the directory where you have listmonk
WorkingDirectory=/var/www/html/listmonk
# the file to execute
ExecStart=/var/www/html/listmonk/listmonk
Restart=always
RestartSec=10
[Install]
WantedBy=multi-user.target
```
- enable the service `systemct enable listmonk.service` and restart the daemon `systemctl daemon-restart` or you can start just the service `systemctl start listmonk.service`
#### fixing small dependencies
- uploads fail: `mkdir /var/www/html/listmonk/uploads` and `chown -R www-data:www-data /var/www/html/listmonk`
___________________
### Heroku

View file

@ -57,6 +57,10 @@ ul.no {
position: relative;
}
.content pre {
white-space: pre-wrap;
}
section {
&.wrap {
max-width: 1100px;
@ -65,6 +69,7 @@ section {
max-width: 900px;
}
}
.spinner.is-tiny {
display: inline-block;
height: 10px;