minor with docs
This commit is contained in:
@@ -21,6 +21,10 @@ $svg-citation-color: "495057";
|
|||||||
padding: 4px 0px 0px 0px !important;
|
padding: 4px 0px 0px 0px !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.main {
|
||||||
|
max-width: 1200px;
|
||||||
|
}
|
||||||
|
|
||||||
.premonition {
|
.premonition {
|
||||||
display: grid;
|
display: grid;
|
||||||
grid-template-columns: 43px auto;
|
grid-template-columns: 43px auto;
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ This release is a complete rewrite of frontend UI and many internals, main chang
|
|||||||
|
|
||||||
- Switch UI framework from [element](https://element.eleme.io/) to [vuetify](https://vuetifyjs.com/)
|
- Switch UI framework from [element](https://element.eleme.io/) to [vuetify](https://vuetifyjs.com/)
|
||||||
- Distribute package directly from site instead of using npm registry
|
- Distribute package directly from site instead of using npm registry
|
||||||
- Improve docker setup (run as user)
|
- Improve docker setup (run as user, fix some data export)
|
||||||
- New logging system (based on [winston](https://github.com/winstonjs/winston))
|
- New logging system (based on [winston](https://github.com/winstonjs/winston))
|
||||||
- Slugify event URL (keeping old one valid)
|
- Slugify event URL (keeping old one valid)
|
||||||
- Import events from ics and external website using h-event (microformat)
|
- Import events from ics and external website using h-event (microformat) improving [`h-event`](https://microformats.org/wiki/h-event) export
|
||||||
- Hide unconfirmed tags and places
|
- Hide unconfirmed tags and places
|
||||||
- Clean unused places and tags
|
- Clean unused places and tags
|
||||||
- Fix tons of issues
|
- Fix tons of issues
|
||||||
|
|||||||
@@ -11,14 +11,9 @@ permalink: /
|
|||||||
A shared agenda for local communities.
|
A shared agenda for local communities.
|
||||||
{: .fs-6 }
|
{: .fs-6 }
|
||||||
|
|
||||||
[Get started now](install){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } [Demo](https://demo.gancio.org){: .btn .btn-green .fs-5 .mb-4 .mb-md-0 }
|
[Install]({% link install/install.md %}){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } [Demo](https://demo.gancio.org){: .btn .btn-green .fs-5 .mb-4 .mb-md-0 }
|
||||||
[Source](https://framagit.org/les/gancio){: .btn .fs-5 }
|
[Source](https://framagit.org/les/gancio){: .btn .fs-5 }
|
||||||
|
|
||||||
[](assets/home1.png){: data-fancybox="group" data-caption="Home of the first gancio instance"}
|
|
||||||
[](assets/mobile1.png){: data-fancybox="group" data-caption="Home mobile"}
|
|
||||||
[](assets/mobile2.png){: data-fancybox="group" data-caption="Home mobile"}
|
|
||||||
[](assets/admin_users.png){: data-fancybox="group" data-caption="Admin interface"}
|
|
||||||
|
|
||||||
|
|
||||||
## Some relevant key features:
|
## Some relevant key features:
|
||||||
|
|
||||||
@@ -29,7 +24,7 @@ nowhere on gancio appears the identity of who published the event, not even unde
|
|||||||
|
|
||||||
- **Anonymous events**: optionally a visitor can create events without being registered (an administrator has to confirm them)
|
- **Anonymous events**: optionally a visitor can create events without being registered (an administrator has to confirm them)
|
||||||
|
|
||||||
- **We are not interested in making hits** so we export events in many ways, via RSS feeds, via global or individual ics, incorporating lists of events or single event via iframe on other websites and via [AP](/federation)
|
- **We are not interested in making hits** so we export events in many ways, via RSS feeds, via global or individual ics, incorporating lists of events or single event via iframe on other websites and via [AP]({% link federation.md %})
|
||||||
|
|
||||||
- Very easy UI
|
- Very easy UI
|
||||||
- Multidays events support (festival, conferences...)
|
- Multidays events support (festival, conferences...)
|
||||||
|
|||||||
@@ -7,8 +7,8 @@ parent: Install
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
{: .no_toc }
|
{: .no_toc }
|
||||||
Main `gancio` configuration is done with a configuration file.
|
`gancio` configuration is done during installation process but you can change it editing the configuration file. Note that you can always re-run gancio with `--setup` flag to use the interactive setup.
|
||||||
This shoud be a `.json` or a `.js` file and could be specified using the `--config` flag.
|
The configuration file shoud be a `.json` or a `.js` file and could be specified using the `--config` flag.
|
||||||
|
|
||||||
- <small>eg. `gancio start --config ./config.json`</small>
|
- <small>eg. `gancio start --config ./config.json`</small>
|
||||||
- <small>eg. `pm2 start gancio start -- --config ~/config.json`</small>
|
- <small>eg. `pm2 start gancio start -- --config ~/config.json`</small>
|
||||||
@@ -77,11 +77,6 @@ Email of administrator. Note that email from gancio comes from this email and th
|
|||||||
the SMTP configuration above should allow to use this address as from.
|
the SMTP configuration above should allow to use this address as from.
|
||||||
|
|
||||||
|
|
||||||
- ### Favicon
|
|
||||||
You could specify another favicon. This is also used as logo (top-left
|
|
||||||
corner):
|
|
||||||
`"favicon": "./favicon.ico"`
|
|
||||||
|
|
||||||
- ### User locale
|
- ### User locale
|
||||||
Probably you want to modify some text for your specific community, that's
|
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
|
why we thought the `user_locale` configuration: you can specify your version of
|
||||||
@@ -105,8 +100,6 @@ list of strings you can override.
|
|||||||
<small>:warning: Note that a restart is needed when you change
|
<small>:warning: Note that a restart is needed when you change
|
||||||
user_locale's content.</small>
|
user_locale's content.</small>
|
||||||
|
|
||||||
- ### Secret
|
|
||||||
|
|
||||||
|
|
||||||
## Default settings
|
## Default settings
|
||||||
```json
|
```json
|
||||||
@@ -115,15 +108,14 @@ user_locale's content.</small>
|
|||||||
"description": "A shared agenda for local communities",
|
"description": "A shared agenda for local communities",
|
||||||
"baseurl": "http://localhost:13120",
|
"baseurl": "http://localhost:13120",
|
||||||
"server": {
|
"server": {
|
||||||
"host": "0.0.0.0",
|
"host": "127.0.0.1",
|
||||||
"port": 13120
|
"port": 13120
|
||||||
},
|
},
|
||||||
"db": {
|
"db": {
|
||||||
"dialect": "sqlite",
|
"dialect": "sqlite",
|
||||||
"storage": "/tmp/db.sqlite"
|
"storage": "./db.sqlite"
|
||||||
},
|
},
|
||||||
"upload_path": "./",
|
"upload_path": "./",
|
||||||
"favicon": "../dist/favicon.ico",
|
|
||||||
"smtp": {
|
"smtp": {
|
||||||
"auth": {
|
"auth": {
|
||||||
"user": "",
|
"user": "",
|
||||||
@@ -133,6 +125,5 @@ user_locale's content.</small>
|
|||||||
"host": ""
|
"host": ""
|
||||||
},
|
},
|
||||||
"admin_email": "",
|
"admin_email": "",
|
||||||
"secret": "notsosecret"
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -49,7 +49,7 @@ gancio start --config config.json
|
|||||||
```
|
```
|
||||||
1. Point your web browser to [http://localhost:13120](http://localhost:13120) or where you selected during setup.
|
1. Point your web browser to [http://localhost:13120](http://localhost:13120) or where you selected during setup.
|
||||||
|
|
||||||
1. [Setup nginx as a proxy](/install/nginx)
|
1. [Setup nginx as a proxy]({% link install/nginx.md %})
|
||||||
|
|
||||||
1. To deploy gancio in production you should use something like **[pm2](http://pm2.keymetrics.io/)**:
|
1. To deploy gancio in production you should use something like **[pm2](http://pm2.keymetrics.io/)**:
|
||||||
|
|
||||||
|
|||||||
@@ -67,7 +67,7 @@ docker-compose up -d
|
|||||||
tail -f data/logs/gancio.log
|
tail -f data/logs/gancio.log
|
||||||
```
|
```
|
||||||
|
|
||||||
1. [Setup nginx as a proxy](/install/nginx)
|
1. [Setup nginx as a proxy]({% link install/nginx.md %}
|
||||||
|
|
||||||
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:
|
||||||
|
|
||||||
|
|||||||
@@ -3,11 +3,13 @@ layout: default
|
|||||||
title: Install
|
title: Install
|
||||||
permalink: /install
|
permalink: /install
|
||||||
has_children: true
|
has_children: true
|
||||||
nav_order: 2
|
nav_order: 3
|
||||||
has_toc: false
|
has_toc: false
|
||||||
---
|
---
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
|
You can install gancio on a cheap VPS (500mb of ram will be enough)
|
||||||
|
|
||||||
- [Install on Debian]({% link install/debian.md %})
|
- [Install on Debian]({% link install/debian.md %})
|
||||||
- [Install using docker]({% link install/docker.md %})
|
- [Install using docker]({% link install/docker.md %})
|
||||||
|
|
||||||
@@ -17,4 +19,4 @@ has_toc: false
|
|||||||
- [Backup]({% link install/backup.md %})
|
- [Backup]({% link install/backup.md %})
|
||||||
|
|
||||||
|
|
||||||
If you wanna hack or run the current development release take a look at [Hacking & contribute](../dev)
|
If you wanna hack or run the current development release take a look at [Hacking & contribute]({% link dev/dev.md %})
|
||||||
|
|||||||
@@ -11,4 +11,4 @@ nav_order: 7
|
|||||||
- [chesefa.org](https://chesefa.org) (Naples, Italy)
|
- [chesefa.org](https://chesefa.org) (Naples, Italy)
|
||||||
|
|
||||||
|
|
||||||
<small>Do you want your instance to appear here? [Write us](/contacts).</small>
|
<small>Do you want your instance to appear here? [Write us]({% link contact.md %}).</small>
|
||||||
16
docs/screenshot.md
Normal file
16
docs/screenshot.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
title: Screenshots
|
||||||
|
nav_order: 2
|
||||||
|
permalink: /screenshot
|
||||||
|
---
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
[](assets/home_desktop.png){: data-fancybox="group" data-caption="Home"}
|
||||||
|
[](assets/event.png){: data-fancybox="group" data-caption="Event"}
|
||||||
|
[](assets/mobile.png){: data-fancybox="group" data-caption="Mobile"}
|
||||||
|
[](assets/add.png){: data-fancybox="group" data-caption="Add event"}
|
||||||
|
[](assets/share.png){: data-fancybox="group" data-caption="Share"}
|
||||||
|
[](assets/options.png){: data-fancybox="group" data-caption="Admin options"}
|
||||||
|
[](assets/federation.png){: data-fancybox="group" data-caption="Admin federation"}
|
||||||
|
[](assets/follow.png){: data-fancybox="group" data-caption="Follow"}
|
||||||
Reference in New Issue
Block a user