mirrors/remark42
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

allow mongo with URL only, update readme for different stores

Browse Source
This commit is contained in:
Umputun
2018-07-13 14:16:03 -05:00
parent de013c7d5a
commit a22521ab92
2 changed files with 15 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -4
View File
@@ -35,9 +35,12 @@ Remark42 is a self-hosted, lightweight, and simple (yet functional) comment engi
| ------------------ | ------------------ | --------------------- | ---------------------------------------------- |
| url | REMARK_URL | | url to remark42 server, _required_ |
| secret | SECRET | | secret key, _required_ |
| site | SITE | `remark` | site name(s), _multi_ |
| store.type | STORE_TYPE | `bolt` | type of storage, `bolt` or `mongo` |
| store.bolt.path | STORE_BOLT_PATH | `./var` | path to data directory |
| store.bolt.timeout | STORE_BOLT_TIMEOUT | `30s` | boltdb access timeout |
| site | SITE | `remark` | site name(s), _multi_ |
| store.mongo.url | STORE_MONGO_URL | | mongo url for data store |
| store.mongo.db | STORE_MONGO_DB | | mongo db for data store |
| admin | ADMIN | | admin names (list of user ids), _multi_ |
| admin-email | ADMIN_EMAIL | `admin@${REMARK_URL}` | admin email |
| backup | BACKUP_PATH | `./var/backup` | backups location |
@@ -45,7 +48,10 @@ Remark42 is a self-hosted, lightweight, and simple (yet functional) comment engi
| cache.max.items | CACHE_MAX_ITEMS | `1000` | max number of cached items, `0` - unlimited |
| cache.max.value | CACHE_MAX_VALUE | `65536` | max size of cached value, `0` - unlimited |
| cache.max.size | CACHE_MAX_SIZE | `50000000` | max size of all cached values, `0` - unlimited |
| avatar.path | AVATAR_FS_PATH | `./var/avatars` | avatars location |
| avatar.type | AVATAR_TYPE | `fs` | type of avatar storage, `fs` or `mongo` |
| avatar.fs.path | AVATAR_FS_PATH | `./var/avatars` | avatars location for `fs` store |
| avatar.mongo.url | AVATAR_MONGO_URL | | mongo url for avatar store |
| avatar.mongo.db | AVATAR_MONGO_DB | | mongo db for avatar store |
| avatar.rsz-lmt | AVATAR_RSZ_LMT | 0 | max image size for resizing avatars on save |
| max-comment | MAX_COMMENT_SIZE | 2048 | comment's size limit |
| auth.ttl.jwt | AUTH_TTL_JWT | 5m | jwt TTL |
@@ -75,8 +81,8 @@ Remark42 is a self-hosted, lightweight, and simple (yet functional) comment engi
Most of the parameters have sane defaults and don't require customization. There are only a few parameters user has to define:
1. `SECRET` - secret key, can be any long and hard-to-guess string.
1. `REMARK_URL` - url pointing to your remark42 server, i.e. `https://demo.reamark42.com`
2. At least one pair of `AUTH_<PROVIDER>_CID` and `AUTH_<PROVIDER>_CSEC` defining oauth2 provider(s)
2. `REMARK_URL` - url pointing to your remark42 server, i.e. `https://demo.reamark42.com`
3. At least one pair of `AUTH_<PROVIDER>_CID` and `AUTH_<PROVIDER>_CSEC` defining oauth2 provider(s)
The minimal `docker-compose.yml` has to include all required parameters:
backend/app/main.go
+5 -24
View File
@@ -14,7 +14,6 @@ import (
"github.com/umputun/remark/backend/app/store/avatar"
"github.com/coreos/bbolt"
"github.com/globalsign/mgo"
"github.com/hashicorp/logutils"
"github.com/jessevdk/go-flags"
"github.com/pkg/errors"
@@ -106,13 +105,8 @@ type CacheGroup struct {
// MongoOpts holds all mongo params
type MongoOpts struct {
URL string `long:"url" env:"URL" description:"mongo url"`
Server []string `long:"server" env:"SERVER" description:"mongo host:port" env-delim:","`
DB string `long:"db" env:"DB" default:"remark42" description:"mongo database"`
User string `long:"user" env:"USER" default:"" description:"mongo user"`
Passwd string `long:"password" env:"PASSWD" default:"" description:"mongo pssword"`
SSL bool `long:"ssl" env:"SSL" description:"connect to mongo with ssl"`
Dbg bool `long:"dbg" env:"DEBUG" description:"enable mongo debug"`
URL string `long:"url" env:"URL" description:"mongo url"`
DB string `long:"db" env:"DB" default:"remark42" description:"mongo database"`
}
var revision = "unknown"
@@ -375,23 +369,10 @@ func makeDirs(dirs ...string) error {
}
func makeMongo(mopts MongoOpts) (result *mongo.Server, err error) {
if mopts.URL != "" {
log.Print("[DEBUG] mongo url provided")
return mongo.NewServerWithURL(mopts.URL, 10*time.Second)
if mopts.URL == "" {
return nil, errors.New("no mongo URL provided")
}
dial := mgo.DialInfo{
Addrs: mopts.Server,
Database: mopts.DB,
Timeout: 10 * time.Second,
Username: mopts.User,
Password: mopts.Passwd,
Source: "admin",
}
return mongo.NewServer(dial, mongo.ServerParams{
Debug: mopts.Dbg,
SSL: mopts.SSL,
})
return mongo.NewServerWithURL(mopts.URL, 10*time.Second)
}
func makeAuthProviders(jwtService *auth.JWT, avatarProxy *proxy.Avatar, ds *service.DataStore, opts Opts) []auth.Provider {