encrypt/gancio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[doc] premonition, oauth

Browse Source
This commit is contained in:
les
2020-01-21 22:14:46 +01:00
parent ff82780eaf
commit 6db3836c35
39 changed files with 822 additions and 651 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/Gemfile
View File

@@ -23,6 +23,7 @@ gem "mini_magick"
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.6"
gem "jemoji"
gem "premonition", "~> 2.0.0"
end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem

2
docs/Gemfile.lock
View File

@@ -66,6 +66,7 @@ GEM
mini_portile2 (~> 2.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
premonition (2.0.0)
public_suffix (3.1.1)
rake (12.3.1)
rb-fsevent (0.10.3)
@@ -95,6 +96,7 @@ DEPENDENCIES
jemoji
just-the-docs
mini_magick
premonition (~> 2.0.0)
tzinfo (~> 1.2)
tzinfo-data
wdm (~> 0.1.0)

4
docs/_config.yml
View File

@@ -28,7 +28,7 @@ theme: "just-the-docs"
plugins:
- jekyll-feed
- jemoji
- premonition
search_enabled: true
@@ -39,6 +39,8 @@ aux_links:
- https://framagit.org/les/gancio
"Forum":
- https://socialhub.activitypub.rocks/c/software/gancio
"Mastodon":
- https://mastodon.cisti.org/@gancio

2
docs/_includes/head.html
View File

@@ -11,6 +11,8 @@
<link rel="shortcut icon" href="{{ "favicon.ico" | absolute_url }}" type="image/x-icon">
<link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
<link rel="stylesheet" href="{{ "/assets/css/style.css" | absolute_url }}">
<link rel="stylesheet" href="{{ "/assets/css/premonition.css" | absolute_url }}">
<link rel="stylesheet" href="{{ "/assets/css/fa.min.css" | absolute_url }}">
{% if site.search_enabled != nil %}
<script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>

72
docs/_site/404.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/404.html" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/404.html","headline":"Gancio","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Gancio","url":"https://gancio.org/404.html","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

72
docs/_site/about.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/about" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/about","headline":"About","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"About","url":"https://gancio.org/about","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/about" class="navigation-list-link active">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

9
docs/_site/assets/css/style.css
View File

@@ -10,3 +10,12 @@
.navigation-list-item a:hover {
color: black;
}
html, body {
font-family: sans-serif;
}
.page-content h1:first-of-type {
font-weight: 500;
}

BIN
docs/_site/assets/gancio.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.5 KiB

56
docs/_site/assets/js/search-data.json
View File

@@ -29,66 +29,66 @@
},
"4": {
"id": "4",
"title": "Contacts",
"content": "Contacts :elephant: Mastodon ⇒ @gancio@mastodon.cisti.org",
"url": "https://gancio.org/contacts",
"relUrl": "/contacts"
},
"5": {
"id": "5",
"title": "Debian",
"content": "Debian installation Install Node.js &amp; yarn (from root) curl -sL https://deb.nodesource.com/setup_12.x | bash - apt-get install -y nodejs curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - echo &quot;deb https://dl.yarnpkg.com/debian/ stable main&quot; &gt; /etc/apt/sources.list.d/yarn.list apt-get update &amp;&amp; apt-get install yarn source Install Gancio yarn global add gancio --prod Setup with postgreSQL (optional as you can choose sqlite) apt-get install postgresql # Create the database su postgres -c psql postgres=# create database gancio; postgres=# create user gancio with encrypted password &#39;gancio&#39;; postgres=# grant all privileges on database gancio to gancio; Create a user to run gancio from adduser gancio su gancio Launch interactive setup gancio setup --config config.json Start gancio start --config config.json Point your web browser to http://localhost:13120 or where you selected during setup. Setup nginx as a proxy To deploy gancio in production you should use something like pm2: sudo yarn global add pm2 pm2 start gancio -- --config config.json # Run this command to run your application as a service and automatically restart after a reboot: pm2 startup # read the output! sudo pm2 startup -u gancio Upgrade sudo yarn global add gancio sudo service pm2 restart",
"url": "https://gancio.org/install/debian",
"relUrl": "/install/debian"
},
"5": {
"id": "5",
"6": {
"id": "6",
"title": "Hacking",
"content": "Development Stack Gancio is built with following technologies: Nuxt.js Vue.js Express Node.js Sequelize Element.ui Testing on your own machine Download source git clone https://framagit.org/les/gancio Install dependencies yarn Hacking yarn dev Please use the issue board and the forum to discuss any modification.",
"url": "https://gancio.org/dev",
"relUrl": "/dev"
},
"6": {
"id": "6",
"7": {
"id": "7",
"title": "Docker",
"content": "Initial setup Use sqlite Use postgreSQL Start gancio Upgrade Initial setup You do not need to clone the full repo as we distribute gancio via npm. A Dockerfile and a docker-compose.yml are the only files needed. Create a directory where everything related to gancio is stored (db, images, config) mkdir /opt/gancio cd /opt/gancio note that you can choose a different directory. Use sqlite Download docker-compose.yml and Dockerfile wget https://gancio.org/docker/Dockerfile wget https://gancio.org/docker/sqlite/docker-compose.yml Create an empty db and config (this is needed) touch config.json db.sqlite mkdir user_locale Build docker image and launch interactive setup in one step docker-compose build docker-compose run --rm gancio gancio setup --docker --db=sqlite Use postgreSQL Download docker-compose.yml and Dockerfile wget https://gancio.org/docker/Dockerfile wget https://gancio.org/docker/postgres/docker-compose.yml Create an empty configuration (this is needed) touch config.json mkdir user_locale Build docker image and launch interactive setup in one step docker-compose build docker-compose run --rm gancio gancio setup --docker --db=postgres Start gancio Run your container docker-compose up -d Look at logs with docker-compose logs Setup nginx as a proxy Point your web browser to http://localhost:13120 or where you specified during setup and enjoy :tada: You can edit config.json file and restart the container on your needs, see Configuration for more details. Upgrade cd /opt/gancio docker-compose up -d --no-deps --build",
"url": "https://gancio.org/install/docker",
"relUrl": "/install/docker"
},
"7": {
"id": "7",
"8": {
"id": "8",
"title": "Federation",
"content": "Federation Each instance has only one AP Actor that publishes each event. We are considering the introduction of other “Actor” but they will not be linked to users, rather to places or tags/categories. There are no personal homes with a timeline of people I follow, everyone has a sort of local timeline of the instance, it’s an anti filter-bubble feature. Events are not published with the type Event but with type Note because we wanted to add the possibility to interact with events from mastodon instances (boost / bookmark and “comments” that we call resources because we don’t want it to become a place of debate, but more a place where to keep a historical memory of events, e.g. an audio recording of a talk). When mastodon will support Event object type we will change for sure.",
"url": "https://gancio.org/federation",
"relUrl": "/federation"
},
"8": {
"id": "8",
"9": {
"id": "9",
"title": "Home",
"content": "Gancio A shared agenda for local communities. Get started now Demo Source Some relevant key features: Focus on content not on people: nowhere on gancio appears the identity of who published the event, not even under a nickname, not even to administrators (except in the db). This is not an ego-friendly platform. Visitors first. We do not want logged user to get more features than random visitor. We do not want users to register, except to publish events and even in this case you can publish an anonymous event. 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. Very easy UI Multidays events support (festival, conferences…) Recurrent events support (each monday, each two monday, each monday and friday, each two saturday, etc.) Filters events for tags or places RSS and ICS export (with filters) embeddable iframe (example) boost / bookmark / comment events from the fediverse! Lot of configurations available (user registration open/close, enable federation, enable recurrent events) License Gancio is distributed by an AGPL-3.0 Licence.",
"content": "ancio A shared agenda for local communities. Get started now Demo Source Some relevant key features: Focus on content not on people: nowhere on gancio appears the identity of who published the event, not even under a nickname, not even to administrators (except in the db). This is not an ego-friendly platform. Visitors first. We do not want logged user to get more features than random visitor. We do not want users to register, except to publish events and even in this case you can publish an anonymous event. 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 Very easy UI Multidays events support (festival, conferences…) Recurrent events support (each monday, each two monday, each monday and friday, each two saturday, etc.) Filters events for tags or places RSS and ICS export (with filters) embeddable iframe (example) boost / bookmark / comment events from the fediverse! Lot of configurations available (user registration open/close, enable federation, enable recurrent events) License Gancio is distributed by an AGPL-3.0 Licence.",
"url": "https://gancio.org/",
"relUrl": "/"
},
"9": {
"id": "9",
"10": {
"id": "10",
"title": "Install",
"content": "Install (production) Install on Debian Install using docker Post installation Nginx as a proxy If you wanna hack or run the current develop release take a look at Hacking &amp; contribute",
"url": "https://gancio.org/install",
"relUrl": "/install"
},
"10": {
"id": "10",
"11": {
"id": "11",
"title": "Instances",
"content": "Instances gancio.cisti.org (Torino, Italy) lapunta.org (Firenze, Italy)",
"content": "Instances gancio.cisti.org (Torino, Italy) lapunta.org (Firenze, Italy) Do you want your instance to appear here? Write us.",
"url": "https://gancio.org/instances",
"relUrl": "/instances"
},
"11": {
"id": "11",
"title": "Support a new language",
"content": "Add a new locale watch this commit",
"url": "https://gancio.org/dev/locales",
"relUrl": "/dev/locales"
},
"12": {
"id": "12",
"title": "Migration",
"content": "If you need to modify the db’s structure while hacking, just change server/api/models/ and remember to create a migration, to understand how things works check the sequelize documentation",
"url": "https://gancio.org/dev/migration",
"relUrl": "/dev/migration"
"title": "Internationalization",
"content": "Internationalization We’re self-hosting an instance of weblate you can use to help us with translations.",
"url": "https://gancio.org/dev/locales",
"relUrl": "/dev/locales"
},
"13": {
"id": "13",
@@ -100,9 +100,9 @@
"14": {
"id": "14",
"title": "OAuth",
"content": "OAuth An open standard for token-based authentication and authorization on the Internet. Gancio supports OAuth 2.0, an authorization framework described in RFC 6749 that allows third-party applications to obtain limited access to an HTTP service on behalf of a resource owner, through the use of a standardized authorization flow that generates a client access token to be used with HTTP requests. To obtain an OAuth token for a Gancio instance, make sure that you allow your users to specify the domain they want to connect to before login. Use that domain to acquire a client id/secret and then proceed with normal OAuth 2. Create client Create a new application to obtain OAuth2 credentials. POST /api/client Request parameters client_name string A name for your application redirect_uri string Where the user should be redirected after authorization scopes string Space separated list of scopes. If none is provided, defaults to write as it’s the only supported scope! website string A URL to the homepage of your app Example curl -X POST -d &#39;client_name=Wordpress Event Manager&#39; -d &#39;redirect_uri=https://noblogs.org/&#39; -d &#39;website=https://myapp.example&#39; http://localhost:13120/api/client Returns Application, with client_id and client_secret { &quot;name&quot; : &quot;Wordpress Event Manager&quot;, &quot;scopes&quot; : &quot;write&quot;, &quot;website&quot; : &quot;https://myapp.example&quot;, &quot;client_secret&quot; : &quot;909029fa12797e6bdfb5baf5e379675dfa4e3ad4&quot;, &quot;redirect_uri&quot; : &quot;https://noblogs.org&quot;, &quot;client_id&quot; : &quot;0f377e34b2aaf517f7db534f32d26b0dd938fb6d&quot; } List of scopes write Grant access to add/update events. Authorize a user Displays an authorization form to the user. If approved, it will create and return an authorization code, then redirect to the desired redirect_uri. The authorization code can be used while requesting a token to obtain access to user-level methods. GET /authorize Request parameters response_type string Should be set equal to code redirect_uri string Where the user should be redirected after authorization scope string Should be write client_id string Client ID, obtained during app registration.",
"url": "https://gancio.org/oauth",
"relUrl": "/oauth"
"content": "BETA FEATUREExpect bad behavior and open issues OAuth An open standard for token-based authentication and authorization on the Internet. Gancio supports OAuth 2.0, an authorization framework described in RFC 6749 that allows third-party applications to obtain limited access to an HTTP service on behalf of a resource owner, through the use of a standardized authorization flow that generates a client access token to be used with HTTP requests. To obtain an OAuth token for a Gancio instance, make sure that you allow your users to specify the domain they want to connect to before login. Use that domain to acquire a client id/secret and then proceed with normal OAuth 2. Create client Create a new application to obtain OAuth2 credentials. POST /api/client Request parameters client_name string A name for your application redirect_uris string Where the user should be redirected after authorization scopes string Space separated list of scopes. If none is provided, defaults to event:write as it’s the only supported scope! website string A URL to the homepage of your app Example curl -X POST -d &#39;client_name=Wordpress Event Manager&#39; -d &#39;redirect_uris=https://noblogs.org/&#39; -d &#39;website=https://myapp.example&#39; http://localhost:13120/api/client Returns Application, with client_id and client_secret { &quot;name&quot; : &quot;Wordpress Event Manager&quot;, &quot;scopes&quot; : &quot;event:write&quot;, &quot;website&quot; : &quot;https://myapp.example&quot;, &quot;client_secret&quot; : &quot;909029fa12797e6bdfb5baf5e379675dfa4e3ad4&quot;, &quot;redirect_uris&quot; : &quot;https://noblogs.org&quot;, &quot;client_id&quot; : &quot;0f377e34b2aaf517f7db534f32d26b0dd938fb6d&quot; } List of scopes event:write Grant access to add/update events. Authorize a user Displays an authorization form to the user. If approved, it will create and return an authorization code, then redirect to the desired redirect_uri. The authorization code can be used while requesting a token to obtain access to user-level methods. GET /authorize Request parameters response_type string Should be set equal to code redirect_uri string Where the user should be redirected after authorization scope string Should be event:write client_id string client_id, obtained during app registration. Obtain a token POST /oauth/token Request parameters client_id string client_id obtained during client registration client_secret string client_secret obtained during client registration scope string Should be event:write grant_type string Set equal to authorization_code code string A user authorization code, obtained via /authorize",
"url": "https://gancio.org/dev/oauth",
"relUrl": "/dev/oauth"
},
"15": {
"id": "15",

BIN
docs/_site/assets/oauth_auth.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
docs/_site/assets/thumbs/oauth_auth.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

72
docs/_site/changelog.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/changelog" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/changelog","headline":"Changelog","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Changelog","url":"https://gancio.org/changelog","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

72
docs/_site/config.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/config" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/config","headline":"Configuration","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Configuration","url":"https://gancio.org/config","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -314,7 +316,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

105
docs/_site/dev/migration.html → docs/_site/contacts.html
View File

@@ -5,13 +5,15 @@
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
<title>Migration - Gancio</title>
<title>Contacts - Gancio</title>
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -26,17 +28,17 @@
<script src="https://gancio.org/assets/js/jquery.fancybox.min.js"></script>
<!-- Begin Jekyll SEO tag v2.6.1 -->
<title>Migration | Gancio</title>
<title>Contacts | Gancio</title>
<meta name="generator" content="Jekyll v3.8.6" />
<meta property="og:title" content="Migration" />
<meta property="og:title" content="Contacts" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="A shared agenda for local communities with AP support" />
<meta property="og:description" content="A shared agenda for local communities with AP support" />
<link rel="canonical" href="https://gancio.org/dev/migration" />
<meta property="og:url" content="https://gancio.org/dev/migration" />
<link rel="canonical" href="https://gancio.org/contacts" />
<meta property="og:url" content="https://gancio.org/contacts" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/dev/migration","headline":"Migration","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Contacts","url":"https://gancio.org/contacts","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,7 +167,11 @@
<li class="navigation-list-item active">
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item active">
<a href="https://gancio.org/dev/migration" class="navigation-list-link active">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -258,9 +260,9 @@
<li class="navigation-list-item">
<li class="navigation-list-item active">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link active">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -301,7 +303,8 @@
<div class="search js-search">
<div class="search-input-wrap">
<input type="text" class="js-search-input search-input" tabindex="0" placeholder="Search Gancio" aria-label="Search Gancio" autocomplete="off">
<svg width="14" height="14" viewBox="0 0 28 28" xmlns="http://www.w3.org/2000/svg" class="search-icon"><title>Search</title><g fill-rule="nonzero"><path d="M17.332 20.735c-5.537 0-10-4.6-10-10.247 0-5.646 4.463-10.247 10-10.247 5.536 0 10 4.601 10 10.247s-4.464 10.247-10 10.247zm0-4c3.3 0 6-2.783 6-6.247 0-3.463-2.7-6.247-6-6.247s-6 2.784-6 6.247c0 3.464 2.7 6.247 6 6.247z"/><path d="M11.672 13.791L.192 25.271 3.02 28.1 14.5 16.62z"/></g></svg>
<svg width="14" height="14" viewbox="0 0 28 28" xmlns="http://www.w3.org/2000/svg" class="search-icon"><title>Search</title>
<g fill-rule="nonzero"><path d="M17.332 20.735c-5.537 0-10-4.6-10-10.247 0-5.646 4.463-10.247 10-10.247 5.536 0 10 4.601 10 10.247s-4.464 10.247-10 10.247zm0-4c3.3 0 6-2.783 6-6.247 0-3.463-2.7-6.247-6-6.247s-6 2.784-6 6.247c0 3.464 2.7 6.247 6 6.247z"></path><path d="M11.672 13.791L.192 25.271 3.02 28.1 14.5 16.62z"></path></g></svg>
</div>
<div class="js-search-results search-results-wrap"></div>
</div>
@@ -313,7 +316,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>
@@ -322,19 +327,13 @@
<div class="main-content">
<nav class="breadcrumb-nav">
<ol class="breadcrumb-nav-list">
<li class="breadcrumb-nav-list-item"><a href="https://gancio.org/dev">Hacking</a></li>
<li class="breadcrumb-nav-list-item"><span>Migration</span></li>
</ol>
</nav>
<div id="main-content" class="page-content" role="main">
<p>If you need to modify the db’s structure while hacking, just change <code class="highlighter-rouge">server/api/models/</code> and
remember to create a migration, to understand how things works <a href="https://sequelize.org/master/manual/migrations.html">check the sequelize documentation</a></p>
<h2 id="contacts">Contacts</h2>
<h3 id="elephant-mastodon---ganciomastodoncistiorg">
<img class="emoji" title=":elephant:" alt=":elephant:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f418.png" height="20" width="20"> Mastodon ⇒ <a href="https://mastodon.cisti.org/@gancio">@gancio@mastodon.cisti.org</a>
</h3>

92
docs/_site/dev.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/dev" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/dev","headline":"Hacking","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Hacking","url":"https://gancio.org/dev","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/dev" class="navigation-list-link active">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>
@@ -370,15 +374,13 @@
<li>
<a href="https://gancio.org/dev/locales">Support a new language</a>
</li>
<li>
<a href="https://gancio.org/dev/migration">Migration</a>
</li>
@@ -394,6 +396,9 @@
<li>
<a href="https://gancio.org/dev/oauth">OAuth</a>
</li>
@@ -401,10 +406,9 @@
<li>
<a href="https://gancio.org/dev/locales">Internationalization</a>
</li>

85
docs/_site/dev/locales.html
View File

@@ -5,13 +5,15 @@
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
<title>Support a new language - Gancio</title>
<title>Internationalization - Gancio</title>
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -26,9 +28,9 @@
<script src="https://gancio.org/assets/js/jquery.fancybox.min.js"></script>
<!-- Begin Jekyll SEO tag v2.6.1 -->
<title>Support a new language | Gancio</title>
<title>Internationalization | Gancio</title>
<meta name="generator" content="Jekyll v3.8.6" />
<meta property="og:title" content="Support a new language" />
<meta property="og:title" content="Internationalization" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="A shared agenda for local communities with AP support" />
<meta property="og:description" content="A shared agenda for local communities with AP support" />
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/dev/locales" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/dev/locales","headline":"Support a new language","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Internationalization","url":"https://gancio.org/dev/locales","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/dev/locales" class="navigation-list-link active">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/dev/locales" class="navigation-list-link active">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>
@@ -327,14 +331,15 @@
<li class="breadcrumb-nav-list-item"><a href="https://gancio.org/dev">Hacking</a></li>
<li class="breadcrumb-nav-list-item"><span>Support a new language</span></li>
<li class="breadcrumb-nav-list-item"><span>Internationalization</span></li>
</ol>
</nav>
<div id="main-content" class="page-content" role="main">
<h3 id="add-a-new-locale">Add a new locale</h3>
<p>watch <a href="https://framagit.org/les/gancio/commit/cd95c7eb3b9e4bc4832a7b33d8d79b4fd3cbda2d">this commit</a></p>
<h2 id="internationalization">Internationalization</h2>
<p>We’re self-hosting an instance of <a href="https://weblate.gancio.org">weblate</a> you can use to help us with translations.</p>

153
docs/_site/oauth.html → docs/_site/dev/oauth.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -32,11 +34,11 @@
<meta property="og:locale" content="en_US" />
<meta name="description" content="A shared agenda for local communities with AP support" />
<meta property="og:description" content="A shared agenda for local communities with AP support" />
<link rel="canonical" href="https://gancio.org/oauth" />
<meta property="og:url" content="https://gancio.org/oauth" />
<link rel="canonical" href="https://gancio.org/dev/oauth" />
<meta property="og:url" content="https://gancio.org/dev/oauth" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/oauth","headline":"OAuth","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"OAuth","url":"https://gancio.org/dev/oauth","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,7 +167,11 @@
<li class="navigation-list-item">
<li class="navigation-list-item active">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link active">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -268,9 +270,9 @@
<li class="navigation-list-item active">
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link active">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>
@@ -322,20 +326,34 @@
<div class="main-content">
<nav class="breadcrumb-nav">
<ol class="breadcrumb-nav-list">
<li class="breadcrumb-nav-list-item"><a href="https://gancio.org/dev">Hacking</a></li>
<li class="breadcrumb-nav-list-item"><span>OAuth</span></li>
</ol>
</nav>
<div id="main-content" class="page-content" role="main">
<h2 class="no_toc" id="oauth">OAuth</h2>
<div class="premonition error"><div class="fa fa-exclamation-triangle"></div><div class="content"><p class="header">BETA FEATURE</p><p>Expect bad behavior and open <a href="https://framagit.org/les/gancio/issues">issues</a></p>
</div></div>
<h2 class="no_toc" id="oauth">OAuth</h2>
<p>An open standard for token-based authentication and authorization on the Internet.</p>
<p>Gancio supports OAuth 2.0, an authorization framework described in <a href="https://tools.ietf.org/html/rfc6749">RFC 6749</a> that allows third-party applications to obtain limited access to an HTTP service on behalf of a resource owner, through the use of a standardized authorization flow that generates a client access token to be used with HTTP requests.</p>
<p>To obtain an OAuth token for a Gancio instance, make sure that you allow your users to specify the domain they want to connect to before login. Use that domain to <a href="#create-client">acquire a client id/secret</a> and then proceed with normal OAuth 2.</p>
<hr />
<h2 id="create-client">Create client</h2>
<p>Create a new application to obtain OAuth2 credentials.</p>
<p class="label label-yellow">POST</p>
<p><code class="highlighter-rouge">/api/client</code></p>
<h4 id="request-parameters">Request parameters</h4>
@@ -348,14 +366,14 @@
<td>A name for your application</td>
</tr>
<tr>
<td>redirect_uri</td>
<td>redirect_uris</td>
<td><code class="highlighter-rouge">string</code></td>
<td>Where the user should be redirected after authorization</td>
</tr>
<tr>
<td>scopes</td>
<td><code class="highlighter-rouge">string</code></td>
<td>Space separated list of scopes. If none is provided, defaults to <code class="highlighter-rouge">write</code> as it’s the only supported scope!</td>
<td>Space separated list of scopes. If none is provided, defaults to <code class="highlighter-rouge">event:write</code> as it’s the only supported scope!</td>
</tr>
<tr>
<td>website</td>
@@ -368,7 +386,7 @@
<h4 id="example">Example</h4>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>curl <span class="nt">-X</span> POST <span class="se">\</span>
<span class="nt">-d</span> <span class="s1">'client_name=Wordpress Event Manager'</span> <span class="se">\</span>
<span class="nt">-d</span> <span class="s1">'redirect_uri=https://noblogs.org/'</span> <span class="se">\</span>
<span class="nt">-d</span> <span class="s1">'redirect_uris=https://noblogs.org/'</span> <span class="se">\</span>
<span class="nt">-d</span> <span class="s1">'website=https://myapp.example'</span> <span class="se">\</span>
http://localhost:13120/api/client
</code></pre></div></div>
@@ -378,17 +396,17 @@
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"Wordpress Event Manager"</span><span class="p">,</span><span class="w">
</span><span class="s2">"scopes"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"write"</span><span class="p">,</span><span class="w">
</span><span class="s2">"scopes"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"event:write"</span><span class="p">,</span><span class="w">
</span><span class="s2">"website"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"https://myapp.example"</span><span class="p">,</span><span class="w">
</span><span class="s2">"client_secret"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"909029fa12797e6bdfb5baf5e379675dfa4e3ad4"</span><span class="p">,</span><span class="w">
</span><span class="s2">"redirect_uri"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"https://noblogs.org"</span><span class="p">,</span><span class="w">
</span><span class="s2">"redirect_uris"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"https://noblogs.org"</span><span class="p">,</span><span class="w">
</span><span class="s2">"client_id"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"0f377e34b2aaf517f7db534f32d26b0dd938fb6d"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div></div>
<h4 id="list-of-scopes">List of scopes</h4>
<ul>
<li><code class="highlighter-rouge">write</code><br />
<li><code class="highlighter-rouge">event:write</code><br />
Grant access to add/update events.</li>
</ul>
@@ -396,6 +414,8 @@ Grant access to add/update events.</li>
<p>Displays an authorization form to the user. If approved, it will create and return an authorization code, then redirect to the desired <code class="highlighter-rouge">redirect_uri</code>.
The authorization code can be used while requesting a token to obtain access to user-level methods.</p>
<p><a href="assets/oauth_auth.png" data-fancybox="group" data-caption="OAuth authorization form"><img src="assets/thumbs/oauth_auth.png" alt="assets/thumbs/oauth_auth.png" /></a></p>
<p class="label label-green">GET</p>
<p><code class="highlighter-rouge">/authorize</code></p>
@@ -416,12 +436,49 @@ The authorization code can be used while requesting a token to obtain access to
<tr>
<td>scope</td>
<td><code class="highlighter-rouge">string</code></td>
<td>Should be <code class="highlighter-rouge">write</code></td>
<td>Should be <code class="highlighter-rouge">event:write</code></td>
</tr>
<tr>
<td>client_id</td>
<td><code class="highlighter-rouge">string</code></td>
<td>Client ID, obtained during app registration.</td>
<td><code class="highlighter-rouge">client_id</code>, obtained during app registration.</td>
</tr>
</tbody>
</table>
<h2 id="obtain-a-token">Obtain a token</h2>
<p class="label label-yellow">POST</p>
<p><code class="highlighter-rouge">/oauth/token</code></p>
<h4 id="request-parameters-2">Request parameters</h4>
<table>
<tbody>
<tr>
<td>client_id</td>
<td><code class="highlighter-rouge">string</code></td>
<td><code class="highlighter-rouge">client_id</code> obtained during <a href="#create-client">client registration</a></td>
</tr>
<tr>
<td>client_secret</td>
<td><code class="highlighter-rouge">string</code></td>
<td><code class="highlighter-rouge">client_secret</code> obtained during <a href="#create-client">client registration</a></td>
</tr>
<tr>
<td>scope</td>
<td><code class="highlighter-rouge">string</code></td>
<td>Should be <code class="highlighter-rouge">event:write</code></td>
</tr>
<tr>
<td>grant_type</td>
<td><code class="highlighter-rouge">string</code></td>
<td>Set equal to <code class="highlighter-rouge">authorization_code</code></td>
</tr>
<tr>
<td>code</td>
<td><code class="highlighter-rouge">string</code></td>
<td>A user authorization code, obtained via <a href="#authorize-a-user">/authorize</a></td>
</tr>
</tbody>
</table>

72
docs/_site/dev/structure.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/dev/structure" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/dev/structure","headline":"Project Structure","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Project Structure","url":"https://gancio.org/dev/structure","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

BIN
docs/_site/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.2 KiB

76
docs/_site/federation.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/federation" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/federation","headline":"Federation","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Federation","url":"https://gancio.org/federation","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -258,9 +260,9 @@
<li class="navigation-list-item active">
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link active">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -268,9 +270,9 @@
<li class="navigation-list-item">
<li class="navigation-list-item active">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link active">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

2
docs/_site/feed.xml
View File

@@ -1 +1 @@
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.8.6">Jekyll</generator><link href="https://gancio.org/feed.xml" rel="self" type="application/atom+xml" /><link href="https://gancio.org/" rel="alternate" type="text/html" /><updated>2020-01-21T01:24:44+01:00</updated><id>https://gancio.org/feed.xml</id><title type="html">Gancio</title><subtitle>A shared agenda for local communities with AP support</subtitle></feed>
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.8.6">Jekyll</generator><link href="https://gancio.org/feed.xml" rel="self" type="application/atom+xml" /><link href="https://gancio.org/" rel="alternate" type="text/html" /><updated>2020-01-21T22:11:47+01:00</updated><id>https://gancio.org/feed.xml</id><title type="html">Gancio</title><subtitle>A shared agenda for local communities with AP support</subtitle></feed>

76
docs/_site/index.html
View File

@@ -14,6 +14,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -38,7 +40,7 @@
<meta property="og:url" content="https://gancio.org/" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebSite","url":"https://gancio.org/","name":"Gancio","headline":"Home","description":"Gancio is a shared agenda for local communities.","@context":"https://schema.org"}</script>
{"@type":"WebSite","headline":"Home","url":"https://gancio.org/","name":"Gancio","description":"Gancio is a shared agenda for local communities.","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -69,18 +71,6 @@
@@ -100,6 +90,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -126,10 +120,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -152,6 +142,10 @@
@@ -175,6 +169,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -189,20 +187,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -219,6 +203,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -226,6 +215,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -250,6 +248,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -262,7 +264,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -272,7 +274,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -315,7 +317,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>
@@ -324,7 +328,7 @@
<div class="main-content">
<div id="main-content" class="page-content" role="main">
<h1 class="fs-9" id="-gancio"><img src="https://git.lattuga.net/repo-avatars/476" width="60px" /> Gancio</h1>
<h1 class="fs-9" id="-ancio"><img src="assets/gancio.png" alt="" /> ancio</h1>
<p class="fs-6">A shared agenda for local communities.</p>
@@ -350,7 +354,7 @@ nowhere on gancio appears the identity of who published the event, not even unde
<p><strong>Anonymous events</strong>: optionally a visitor can create events without being registered (an administrator has to confirm them)</p>
</li>
<li>
<p><strong>We are not interested in making hits</strong> 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.</p>
<p><strong>We are not interested in making hits</strong> 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 <a href="/federation">AP</a></p>
</li>
<li>Very easy UI</li>
<li>Multidays events support (festival, conferences…)</li>

72
docs/_site/install.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/install" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/install","headline":"Install","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Install","url":"https://gancio.org/install","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/install" class="navigation-list-link active">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

72
docs/_site/install/debian.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/install/debian" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/install/debian","headline":"Debian","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Debian","url":"https://gancio.org/install/debian","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

72
docs/_site/install/docker.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/install/docker" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/install/docker","headline":"Docker","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Docker","url":"https://gancio.org/install/docker","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -314,7 +316,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

72
docs/_site/install/nginx.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/install/nginx" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/install/nginx","headline":"Nginx","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Nginx","url":"https://gancio.org/install/nginx","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/install/nginx" class="navigation-list-link active">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>

74
docs/_site/instances.html
View File

@@ -12,6 +12,8 @@
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
@@ -36,7 +38,7 @@
<meta property="og:url" content="https://gancio.org/instances" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/instances","headline":"Instances","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
{"@type":"WebPage","headline":"Instances","url":"https://gancio.org/instances","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -67,18 +69,6 @@
@@ -98,6 +88,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -124,10 +118,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
@@ -150,6 +140,10 @@
@@ -173,6 +167,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
@@ -187,20 +185,6 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Support a new language</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/migration" class="navigation-list-link">Migration</a>
</li>
@@ -217,6 +201,11 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
@@ -224,6 +213,15 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
@@ -248,6 +246,10 @@
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
@@ -260,7 +262,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
@@ -270,7 +272,7 @@
<li class="navigation-list-item">
<a href="https://gancio.org/oauth" class="navigation-list-link">OAuth</a>
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
@@ -313,7 +315,9 @@
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>
@@ -331,6 +335,8 @@
<li><a href="https://lapunta.org">lapunta.org</a> (Firenze, Italy)</li>
</ul>
<p><small>Do you want your instance to appear here? <a href="/contacts">Write us</a>.</small></p>
</div>

9
docs/assets/css/style.css
View File

@@ -10,3 +10,12 @@
.navigation-list-item a:hover {
color: black;
}
html, body {
font-family: sans-serif;
}
.page-content h1:first-of-type {
font-weight: 500;
}

BIN
docs/assets/gancio.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.5 KiB

BIN
docs/assets/oauth_auth.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
docs/assets/thumbs/oauth_auth.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

11
docs/contact.md Normal file
View File

@@ -0,0 +1,11 @@
---
layout: default
title: Contacts
permalink: /contacts
nav_order: 9
---
## Contacts
### :elephant: Mastodon ⇒ [@gancio@mastodon.cisti.org](https://mastodon.cisti.org/@gancio)

8
docs/dev/locales.md
View File

@@ -1,9 +1,11 @@
---
layout: default
title: Support a new language
title: Internationalization
permalink: /dev/locales
parent: Hacking
nav_order: 7
---
### Add a new locale
watch [this commit](https://framagit.org/les/gancio/commit/cd95c7eb3b9e4bc4832a7b33d8d79b4fd3cbda2d)
## Internationalization
We're self-hosting an instance of [weblate](https://weblate.gancio.org) you can use to help us with translations.

11
docs/dev/migration.md
View File

@@ -1,11 +0,0 @@
---
layout: default
title: Migration
permalink: /dev/migration
parent: Hacking
---
If you need to modify the db's structure while hacking, just change `server/api/models/` and
remember to create a migration, to understand how things works [check the sequelize documentation](https://sequelize.org/master/manual/migrations.html)

41
docs/oauth.md → docs/dev/oauth.md
View File

@@ -1,10 +1,14 @@
---
layout: default
title: OAuth
permalink: /oauth
nav_order: 9
permalink: /dev/oauth
parent: Hacking
nav_order: 4
---
> error "BETA FEATURE"
> Expect bad behavior and open [issues](https://framagit.org/les/gancio/issues)
## OAuth
{: .no_toc }
An open standard for token-based authentication and authorization on the Internet.
@@ -13,12 +17,13 @@ Gancio supports OAuth 2.0, an authorization framework described in [RFC 6749](ht
To obtain an OAuth token for a Gancio instance, make sure that you allow your users to specify the domain they want to connect to before login. Use that domain to [acquire a client id/secret](#create-client) and then proceed with normal OAuth 2.
---
## Create client
Create a new application to obtain OAuth2 credentials.
POST
{: .label .label-yellow }
`/api/client`
@@ -26,7 +31,7 @@ POST
| client_name | `string` | A name for your application |
| redirect_uris | `string` | Where the user should be redirected after authorization |
| scopes | `string` | Space separated list of scopes. If none is provided, defaults to `write` as it's the only supported scope!|
| scopes | `string` | Space separated list of scopes. If none is provided, defaults to `event:write` as it's the only supported scope!|
| website | `string` | A URL to the homepage of your app |
#### Example
@@ -44,7 +49,7 @@ Application, with `client_id` and `client_secret`
```json
{
"name" : "Wordpress Event Manager",
"scopes" : "write",
"scopes" : "event:write",
"website" : "https://myapp.example",
"client_secret" : "909029fa12797e6bdfb5baf5e379675dfa4e3ad4",
"redirect_uris" : "https://noblogs.org",
@@ -53,13 +58,16 @@ Application, with `client_id` and `client_secret`
```
#### List of scopes
- `write`
- `event:write`
Grant access to add/update events.
## Authorize a user
Displays an authorization form to the user. If approved, it will create and return an authorization code, then redirect to the desired `redirect_uri`.
The authorization code can be used while requesting a token to obtain access to user-level methods.
[![assets/thumbs/oauth_auth.png](assets/thumbs/oauth_auth.png)](assets/oauth_auth.png){: data-fancybox="group" data-caption="OAuth authorization form"}
GET
{: .label .label-green}
`/authorize`
@@ -68,6 +76,23 @@ GET
| response_type | `string` | Should be set equal to `code` |
| redirect_uri | `string` | Where the user should be redirected after authorization |
| scope | `string` | Should be `write`|
| client_id | `string` | Client ID, obtained during app registration. |
| scope | `string` | Should be `event:write`|
| client_id | `string` | `client_id`, obtained during app registration. |
## Obtain a token
POST
{: .label .label-yellow }
`/oauth/token`
#### Request parameters
| client_id | `string` | `client_id` obtained during [client registration](#create-client) |
| client_secret | `string` | `client_secret` obtained during [client registration](#create-client) |
| scope | `string` | Should be `event:write`|
| grant_type | `string` | Set equal to `authorization_code` |
| code | `string` | A user authorization code, obtained via [/authorize](#authorize-a-user) |

1
docs/dev/structure.md
View File

@@ -3,6 +3,7 @@ layout: default
title: Project Structure
permalink: /dev/structure
parent: Hacking
nav_order: 1
---
### Project structure

BIN
docs/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.2 KiB

4
docs/index.md
View File

@@ -6,7 +6,7 @@ description: "Gancio is a shared agenda for local communities."
permalink: /
---
# <img src='https://git.lattuga.net/repo-avatars/476' width="60px"/> Gancio
# ![](assets/gancio.png) ancio
{: .fs-9 }
A shared agenda for local communities.
@@ -30,7 +30,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)
- **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.
- **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)
- Very easy UI
- Multidays events support (festival, conferences...)

3
docs/instances.md
View File

@@ -9,3 +9,6 @@ nav_order: 7
- [gancio.cisti.org](https://gancio.cisti.org) (Torino, Italy)
- [lapunta.org](https://lapunta.org) (Firenze, Italy)
<small>Do you want your instance to appear here? [Write us](/contacts).</small>