mirror of
https://framagit.org/les/gancio.git
synced 2025-02-01 00:52:01 +01:00
fix docs links path
This commit is contained in:
parent
38d13fae6e
commit
5b1f590f82
6 changed files with 15 additions and 15 deletions
|
@ -7,7 +7,7 @@ POST
|
||||||
**`/event`**
|
**`/event`**
|
||||||
|
|
||||||
> info "info"
|
> info "info"
|
||||||
> `Content-Type` has to be `multipart/form-data` 'cause support image upload
|
> `Content-Type` has to be `multipart/form-data` to support image upload
|
||||||
|
|
||||||
|
|
||||||
**Params**
|
**Params**
|
||||||
|
|
|
@ -17,7 +17,7 @@ title: Gancio
|
||||||
email: lesion@autistici.org
|
email: lesion@autistici.org
|
||||||
description: >- # this means to ignore newlines until "baseurl:"
|
description: >- # this means to ignore newlines until "baseurl:"
|
||||||
A shared agenda for local communities with AP support
|
A shared agenda for local communities with AP support
|
||||||
baseurl: "" # the subpath of your site, e.g. /blog
|
baseurl: "/next" # the subpath of your site, e.g. /blog
|
||||||
url: "https://gancio.org" # the base hostname & protocol for your site, e.g. http://example.com
|
url: "https://gancio.org" # the base hostname & protocol for your site, e.g. http://example.com
|
||||||
#twitter_username: jekyllrb
|
#twitter_username: jekyllrb
|
||||||
#github_username: jekyll
|
#github_username: jekyll
|
||||||
|
|
|
@ -21,7 +21,7 @@ POST
|
||||||
**`/event`**
|
**`/event`**
|
||||||
|
|
||||||
> info "info"
|
> info "info"
|
||||||
> `Content-Type` has to be `multipart/form-data` 'cause support image upload
|
> `Content-Type` has to be `multipart/form-data` to support image upload
|
||||||
|
|
||||||
|
|
||||||
**Params**
|
**Params**
|
||||||
|
|
|
@ -19,7 +19,7 @@ apt-get update && apt-get install yarn
|
||||||
|
|
||||||
1. Install Gancio
|
1. Install Gancio
|
||||||
```bash
|
```bash
|
||||||
yarn global add --silent https://gancio.org/latest.tgz 2> /dev/null
|
yarn global add --silent {{site.url}}{% link /latest.tgz %} 2> /dev/null
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Setup with postgreSQL __(optional as you can choose sqlite)__
|
1. Setup with postgreSQL __(optional as you can choose sqlite)__
|
||||||
|
@ -64,6 +64,6 @@ sudo pm2 startup -u gancio
|
||||||
|
|
||||||
## Upgrade
|
## Upgrade
|
||||||
```bash
|
```bash
|
||||||
sudo yarn global add --silent https://gancio.org/latest.tgz 2> /dev/null
|
sudo yarn global add --silent {{site.url}}{% link /latest.tgz %} 2> /dev/null
|
||||||
sudo service pm2 restart
|
sudo service pm2 restart
|
||||||
```
|
```
|
||||||
|
|
|
@ -26,8 +26,8 @@ cd /opt/gancio
|
||||||
<div class='code-example bg-grey-lt-100' markdown="1">
|
<div class='code-example bg-grey-lt-100' markdown="1">
|
||||||
1. **Download docker-compose.yml and Dockerfile**
|
1. **Download docker-compose.yml and Dockerfile**
|
||||||
```bash
|
```bash
|
||||||
wget https://gancio.org/docker/Dockerfile
|
wget {{site.url}}{% link /docker/Dockerfile %}
|
||||||
wget https://gancio.org/docker/sqlite/docker-compose.yml
|
wget {{site.url}}{% link /docker/sqlite/docker-compose.yml %}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@ -43,8 +43,8 @@ docker-compose run --rm gancio gancio setup --docker --db=sqlite
|
||||||
|
|
||||||
1. **Download docker-compose.yml and Dockerfile**
|
1. **Download docker-compose.yml and Dockerfile**
|
||||||
```bash
|
```bash
|
||||||
wget https://gancio.org/docker/Dockerfile
|
wget {{site.url}}{% link /docker/Dockerfile %}
|
||||||
wget https://gancio.org/docker/postgres/docker-compose.yml
|
wget {{site.url}}{% link /docker/postgres/docker-compose.yml %}
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Build docker image and launch interactive setup
|
1. Build docker image and launch interactive setup
|
||||||
|
@ -71,22 +71,22 @@ tail -f data/logs/gancio.log
|
||||||
|
|
||||||
1. Point your web browser to [http://localhost:13120](http://localhost:13120) or where you specified during setup and enjoy :tada:
|
1. Point your web browser to [http://localhost:13120](http://localhost:13120) or where you specified during setup and enjoy :tada:
|
||||||
|
|
||||||
1. Edit `data/config.json` and restart the container on your needs, see [Configuration](/config) for more details.
|
1. Edit `data/config.json` and restart the container on your needs, see [Configuration]({% link install/configuration.md %}) for more details.
|
||||||
|
|
||||||
## Upgrade
|
## Upgrade
|
||||||
|
|
||||||
> warning "Backup your data"
|
> warning "Backup your data"
|
||||||
> Backup your data is generally a good thing to do and this is especially true before upgrading.
|
> Backup your data is generally a good thing to do and this is especially true before upgrading.
|
||||||
> Don't be lazy and [backup](/backup) your data!
|
> Don't be lazy and [backup]({% link install/backup.md %}) your data!
|
||||||
|
|
||||||
|
|
||||||
> error "Upgrade from a version < 1.0"
|
> error "Upgrade from a version < 1.0"
|
||||||
> Since v1.0 our docker setup is changed and a new container has to be built:
|
> Since v1.0 our docker setup is changed and a new container has to be built:
|
||||||
>
|
>
|
||||||
> 1. `cd /opt/gancio`
|
> 1. `cd /opt/gancio`
|
||||||
> 1. [Backup your data](/backup)
|
> 1. [Backup your data]({% link install/backup.md %})
|
||||||
> 1. Download new `Dockerfile` <br/> `wget https://gancio.org/docker/Dockerfile`
|
> 1. Download new `Dockerfile` <br/> `wget {{site.url}}{% link /docker/Dockerfile %}`
|
||||||
> 1. Download new `docker-compose.yml` (substitute \<DB\> to sqlite or postgres): <br/>`wget https://gancio.org/docker/<DB>/docker-compose.yml`
|
> 1. Download new `docker-compose.yml` (substitute `sqlite` to `postgres` in case): <br/>`wget {{site.url}}{% link /docker/sqlite/docker-compose.yml %}`
|
||||||
> 1. Build the new container `docker-compose build`
|
> 1. Build the new container `docker-compose build`
|
||||||
> 1. Extract your backup into `./data` <br/>`mkdir data; tar xvzf gancio-<yourLastBackup>-backup.tgz -C data`
|
> 1. Extract your backup into `./data` <br/>`mkdir data; tar xvzf gancio-<yourLastBackup>-backup.tgz -C data`
|
||||||
> 1. Stop your old container `docker-compose stop`
|
> 1. Stop your old container `docker-compose stop`
|
||||||
|
|
|
@ -71,7 +71,7 @@ api.put('/place', isAdmin, eventController.updatePlace)
|
||||||
* @category Event
|
* @category Event
|
||||||
* @name /event
|
* @name /event
|
||||||
* @type POST
|
* @type POST
|
||||||
* @info `Content-Type` has to be `multipart/form-data` 'cause support image upload
|
* @info `Content-Type` has to be `multipart/form-data` to support image upload
|
||||||
* @param {string} title - event's title
|
* @param {string} title - event's title
|
||||||
* @param {string} description - event's description (html accepted and sanitized)
|
* @param {string} description - event's description (html accepted and sanitized)
|
||||||
* @param {string} place_name - the name of the place
|
* @param {string} place_name - the name of the place
|
||||||
|
|
Loading…
Reference in a new issue