docs: reorg contributing section
This commit is contained in:
Paul Mineev
Umputun
+32
@@ -50,3 +50,35 @@ find ./backend/web -regex '.*\.\(html\|js\|mjs\)$' -print -exec sed -i "s|{% REM
|
||||
To run backend - `cd backend; go run app/main.go server --dbg --secret=12345 --url=http://127.0.0.1:8080 --admin-passwd=password --site=remark`. It stars backend service with embedded bolt store on port `8080` with basic auth, allowing to authenticate and run requests directly, like this:
|
||||
|
||||
`HTTP http://admin:password@127.0.0.1:8080/api/v1/find?site=remark&sort=-active&format=tree&url=http://127.0.0.1:8080`
|
||||
|
||||
## Technical Details
|
||||
|
||||
Data stored in [boltdb](https://github.com/etcd-io/bbolt) (embedded key/value database) files under `STORE_BOLT_PATH`. Each site is stored in a separate boltdb file.
|
||||
|
||||
To migrate/move Remark42 to another host, boltdb files and avatars directory `AVATAR_FS_PATH` should be transferred. Optionally, boltdb can be used to store avatars as well.
|
||||
|
||||
The automatic backup process runs every 24h and exports all content in JSON-like format to `backup-remark-YYYYMMDD.gz`.
|
||||
|
||||
Authentication implemented with [go-pkgz/auth](https://github.com/go-pkgz/auth) stored in a cookie. It uses HttpOnly, secure cookies.
|
||||
|
||||
All heavy REST calls cached internally in LRU cache limited by `CACHE_MAX_ITEMS` and `CACHE_MAX_SIZE` with [go-pkgz/rest](https://github.com/go-pkgz/rest).
|
||||
|
||||
User's activity throttled globally (up to 1000 simultaneous requests) and limited locally (per user, usually up to 10 req/sec).
|
||||
|
||||
Request timeout set to 60sec.
|
||||
|
||||
Admin authentication (`--admin-password` set) allows to hit Remark42 API without social login and admin privileges. Adds basic-auth for username: `admin`, password: `${ADMIN_PASSWD}`. Enable it only for the initial comment import or for manual backups. Do not leave server running with admin password set if you don't have intention to keep creating backups manually!
|
||||
|
||||
User can vote for the comment multiple times but only to change the vote. Double voting is not allowed.
|
||||
|
||||
User can edit comments in 5 mins (configurable) window after creation.
|
||||
|
||||
User ID hashed and prefixed by OAuth provider name to avoid collisions and potential abuse.
|
||||
|
||||
All avatars resized and cached locally to prevent rate limiters from OAuth providers, part of [go-pkgz/auth](https://github.com/go-pkgz/auth) functionality.
|
||||
|
||||
Images served over HTTP can be proxied to HTTPS (`IMAGE_PROXY_HTTP2HTTPS=true`) to prevent mixed HTTP/HTTPS.
|
||||
|
||||
All images can be proxied and saved locally (`IMAGE_PROXY_CACHE_EXTERNAL=true`) instead of serving from the original location. Beware, images that are posted with this parameter enabled will be served from proxy even after it is disabled.
|
||||
|
||||
Docker build uses [publicly available](https://github.com/umputun/baseimage) base images.
|
||||
@@ -1,11 +0,0 @@
|
||||
---
|
||||
title: Development
|
||||
---
|
||||
|
||||
### Backend development
|
||||
|
||||
The backend development guide can be found [here](https://remark42.com/docs/contributing/development/backend/).
|
||||
|
||||
### Frontend development
|
||||
|
||||
The frontend development guide can be found [here](https://remark42.com/docs/contributing/development/frontend/).
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
title: Technical Details
|
||||
---
|
||||
|
||||
Data stored in [boltdb](https://github.com/etcd-io/bbolt) (embedded key/value database) files under `STORE_BOLT_PATH`. Each site is stored in a separate boltdb file.
|
||||
|
||||
To migrate/move Remark42 to another host, boltdb files and avatars directory `AVATAR_FS_PATH` should be transferred. Optionally, boltdb can be used to store avatars as well.
|
||||
|
||||
The automatic backup process runs every 24h and exports all content in JSON-like format to `backup-remark-YYYYMMDD.gz`.
|
||||
|
||||
Authentication implemented with [go-pkgz/auth](https://github.com/go-pkgz/auth) stored in a cookie. It uses HttpOnly, secure cookies.
|
||||
|
||||
All heavy REST calls cached internally in LRU cache limited by `CACHE_MAX_ITEMS` and `CACHE_MAX_SIZE` with [go-pkgz/rest](https://github.com/go-pkgz/rest).
|
||||
|
||||
User's activity throttled globally (up to 1000 simultaneous requests) and limited locally (per user, usually up to 10 req/sec).
|
||||
|
||||
Request timeout set to 60sec.
|
||||
|
||||
Admin authentication (`--admin-password` set) allows to hit Remark42 API without social login and admin privileges. Adds basic-auth for username: `admin`, password: `${ADMIN_PASSWD}`. Enable it only for the initial comment import or for manual backups. Do not leave server running with admin password set if you don't have intention to keep creating backups manually!
|
||||
|
||||
User can vote for the comment multiple times but only to change the vote. Double voting is not allowed.
|
||||
|
||||
User can edit comments in 5 mins (configurable) window after creation.
|
||||
|
||||
User ID hashed and prefixed by OAuth provider name to avoid collisions and potential abuse.
|
||||
|
||||
All avatars resized and cached locally to prevent rate limiters from OAuth providers, part of [go-pkgz/auth](https://github.com/go-pkgz/auth) functionality.
|
||||
|
||||
Images served over HTTP can be proxied to HTTPS (`IMAGE_PROXY_HTTP2HTTPS=true`) to prevent mixed HTTP/HTTPS.
|
||||
|
||||
All images can be proxied and saved locally (`IMAGE_PROXY_CACHE_EXTERNAL=true`) instead of serving from the original location. Beware, images that are posted with this parameter enabled will be served from proxy even after it is disabled.
|
||||
|
||||
Docker build uses [publicly available](https://github.com/umputun/baseimage) base images.
|
||||
+6
-16
@@ -95,18 +95,12 @@
|
||||
"section": "Contributing",
|
||||
"children": [
|
||||
{
|
||||
"title": "Development",
|
||||
"href": "/contributing/development/",
|
||||
"children": [
|
||||
{
|
||||
"title": "Backend",
|
||||
"href": "/contributing/development/backend/"
|
||||
},
|
||||
{
|
||||
"title": "Frontend",
|
||||
"href": "/contributing/development/frontend/"
|
||||
}
|
||||
]
|
||||
"title": "Backend",
|
||||
"href": "/contributing/backend/"
|
||||
},
|
||||
{
|
||||
"title": "Frontend",
|
||||
"href": "/contributing/frontend/"
|
||||
},
|
||||
{
|
||||
"title": "Translations",
|
||||
@@ -115,10 +109,6 @@
|
||||
{
|
||||
"title": "API",
|
||||
"href": "/contributing/api/"
|
||||
},
|
||||
{
|
||||
"title": "Technical Details",
|
||||
"href": "/contributing/technical-details/"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user