Merge pull request #828 from umputun/paskal/logs

documentation: fix email templating doc, add remap doc
This commit is contained in:
Umputun
2020-12-06 14:39:49 -06:00
committed by GitHub
3 changed files with 65 additions and 4 deletions
+30
View File
@@ -0,0 +1,30 @@
---
title: Site URL migration
---
Here is an example on how to move your comments after your posts are moved, from `https://example.org/blog/<slug>` to `https://example.org/post/<slug>` in that example.
### Rules file
First you have to create a `rules` file in remark's `/var` folder.
[Here is the test](https://github.com/akosourov/remark/blob/4dc123dbe84f4f248864bcdbbd6cc2b3a4dafe11/backend/app/migrator/mapper_test.go#L13-L17) with an example of rules file syntax, format is simply `old_url new_url` like following:
```
https://example.org/old-url-1/ https://example.org/new-url-1/
https://example.org/old-url-2/ https://example.org/new-url-2/
```
### Applying the remap
After rules file is ready, run the following command:
```sh
remark42 remap --admin-passwd <password> -f var/rules
```
If running in a docker container, the command becomes:
```sh
docker ps # to find the container name
docker exec -it <container> remark42 remap --admin-passwd <password> -f var/rules
```
@@ -1,9 +1,10 @@
### Email templating
---
title: Email templating
---
We use golang templates for email templating.
templates located in `backend/templates` and embedded into binary by statik
Remark42 uses golang templates for email templating. Templates are located in `backend/templates` and embedded into binary by statik
For getting access to files you can use package `templates` from `backend/app/templates`
For getting access to the files you can use package `templates` from `backend/app/templates`
Now we have following templates:
- `email_confirmation_login.html.tmpl` used for confirmation of login
+30
View File
@@ -0,0 +1,30 @@
---
title: Site URL migration
---
Here is an example on how to move your comments after your posts are moved, from `https://example.org/blog/<slug>` to `https://example.org/post/<slug>` in that example.
### Rules file
First you have to create a `rules` file in remark's `/var` folder.
[Here is the test](https://github.com/akosourov/remark/blob/4dc123dbe84f4f248864bcdbbd6cc2b3a4dafe11/backend/app/migrator/mapper_test.go#L13-L17) with an example of rules file syntax, format is simply `old_url new_url` like following:
```
https://example.org/old-url-1/ https://example.org/new-url-1/
https://example.org/old-url-2/ https://example.org/new-url-2/
```
### Applying the remap
After rules file is ready, run the following command:
```sh
remark42 remap --admin-passwd <password> -f var/rules
```
If running in a docker container, the command becomes:
```sh
docker ps # to find the container name
docker exec -it <container> remark42 remap --admin-passwd <password> -f var/rules
```