update install / backup documentation
This commit is contained in:
@@ -16,22 +16,8 @@ The configuration file shoud be a `.json` or a `.js` file and could be specified
|
||||
1. TOC
|
||||
{:toc}
|
||||
|
||||
- ### Title
|
||||
The title will be in rss feed, in html head and in emails:
|
||||
|
||||
`"title": "Gancio"`
|
||||
|
||||

|
||||
|
||||
- ### Description
|
||||
`"description": "a shared agenda for local communities"`
|
||||
|
||||
- ### BaseURL
|
||||
URL where your site will be accessible (include http or https):
|
||||
`"baseurl": "https://gancio.cisti.org"`
|
||||
|
||||
- ### Server
|
||||
This probably support unix socket too :D
|
||||
This probably support unix socket too
|
||||
|
||||
```json
|
||||
"server": {
|
||||
@@ -52,31 +38,6 @@ DB configuration, look [here](https://sequelize.org/master/class/lib/sequelize.j
|
||||
Where to save images
|
||||
`"upload_path": "./uploads"`
|
||||
|
||||
- ### SMTP
|
||||
SMTP configuration.
|
||||
Gancio should send emails at following events:
|
||||
- the admin should receive emails of anon event (if enabled) to confirm them.
|
||||
- the admin should receive emails of registration request (if enabled) to confirm them.
|
||||
- an user should receive an email of registration requested.
|
||||
- an user should receive an email of confirmed registration.
|
||||
- an user should receive a confirmation email when subscribed directly by admin.
|
||||
|
||||
```json
|
||||
"smtp": {
|
||||
"auth": {
|
||||
"user": "",
|
||||
"pass": ""
|
||||
},
|
||||
"secure": true,
|
||||
"host": ""
|
||||
}
|
||||
```
|
||||
|
||||
- ### Admin_email
|
||||
Email of administrator. Note that email from gancio comes from this email and that
|
||||
the SMTP configuration above should allow to use this address as from.
|
||||
|
||||
|
||||
- ### User locale
|
||||
Probably you want to modify some text for your specific community, that's
|
||||
why we thought the `user_locale` configuration: you can specify your version of
|
||||
@@ -96,34 +57,7 @@ and then point the `user_locale` configuration to that directory:
|
||||
"user_locale": "/opt/gancio/user_locale"
|
||||
```
|
||||
Watch [here](https://framagit.org/les/gancio/tree/master/locales) for a
|
||||
list of strings you can override.
|
||||
<small>:warning: Note that a restart is needed when you change
|
||||
user_locale's content.</small>
|
||||
list of strings you can override.
|
||||
|
||||
|
||||
## Default settings
|
||||
```json
|
||||
{
|
||||
"title": "Gancio",
|
||||
"description": "A shared agenda for local communities",
|
||||
"baseurl": "http://localhost:13120",
|
||||
"server": {
|
||||
"host": "127.0.0.1",
|
||||
"port": 13120
|
||||
},
|
||||
"db": {
|
||||
"dialect": "sqlite",
|
||||
"storage": "./db.sqlite"
|
||||
},
|
||||
"upload_path": "./",
|
||||
"smtp": {
|
||||
"auth": {
|
||||
"user": "",
|
||||
"pass": ""
|
||||
},
|
||||
"secure": true,
|
||||
"host": ""
|
||||
},
|
||||
"admin_email": "",
|
||||
}
|
||||
```
|
||||
> warning "Restart needed"
|
||||
> Note that a restart is needed when you change user_locale's content.
|
||||
|
||||
Reference in New Issue
Block a user