From bb14fbed830d505420d067faa0ec1ffde4aebaa6 Mon Sep 17 00:00:00 2001 From: les Date: Wed, 4 Dec 2019 01:12:59 +0100 Subject: [PATCH] [doc] about and federation --- CHANGELOG | 5 +- docs/_config.yml | 4 +- docs/_includes/head.html | 1 + docs/_site/404.html | 41 +++- docs/_site/about.html | 318 ++++++++++++++++++++++++++ docs/_site/assets/css/style.css | 12 + docs/_site/assets/js/search-data.json | 56 +++-- docs/_site/config.html | 41 +++- docs/_site/dev.html | 43 +++- docs/_site/dev/locales.html | 39 +++- docs/_site/dev/migration.html | 39 +++- docs/_site/dev/structure.html | 39 +++- docs/_site/federation.html | 317 +++++++++++++++++++++++++ docs/_site/feed.xml | 2 +- docs/_site/index.html | 77 +++++-- docs/_site/install.html | 41 +++- docs/_site/install/debian.html | 39 +++- docs/_site/install/docker.html | 39 +++- docs/_site/install/nginx.html | 39 +++- docs/_site/instances.html | 39 +++- docs/about.md | 16 ++ docs/assets/css/style.css | 12 + docs/configuration.md | 2 +- docs/federation.md | 16 ++ docs/index.md | 24 +- docs/install/install.md | 2 +- 26 files changed, 1200 insertions(+), 103 deletions(-) create mode 100644 docs/_site/about.html create mode 100644 docs/_site/assets/css/style.css create mode 100644 docs/_site/federation.html create mode 100644 docs/about.md create mode 100644 docs/assets/css/style.css create mode 100644 docs/federation.md diff --git a/CHANGELOG b/CHANGELOG index 4bcf05f7..c52f0aca 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,9 +1,12 @@ All notable changes to this project will be documented in this file. +### unreleased +- [refactor] remove `username` field +- [doc] about and federation + ### 0.17.8 - [fix] use thumb in head og:img only - ### 0.17.7 - [fix] #58 wrong url for RSS feed diff --git a/docs/_config.yml b/docs/_config.yml index 4e8b1dd3..2a8800e2 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -33,10 +33,12 @@ plugins: search_enabled: true aux_links: + "Blog": + - https://blog.gancio.org "Source": - https://framagit.org/les/gancio "Forum": - - https://framavox.org/g/hMXTDgtJ/gancio + - https://socialhub.activitypub.rocks/c/software/gancio diff --git a/docs/_includes/head.html b/docs/_includes/head.html index 072d79b0..01a680ba 100644 --- a/docs/_includes/head.html +++ b/docs/_includes/head.html @@ -10,6 +10,7 @@ + {% if site.search_enabled != nil %} diff --git a/docs/_site/404.html b/docs/_site/404.html index 910a1fe7..37a93ca0 100644 --- a/docs/_site/404.html +++ b/docs/_site/404.html @@ -11,6 +11,7 @@ + @@ -25,17 +26,17 @@ -Gancio | A shared agenda for local communities +Gancio | A shared agenda for local communities with AP support - - + + +{"@type":"WebPage","url":"https://gancio.org/404.html","headline":"Gancio","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -252,9 +281,11 @@ diff --git a/docs/_site/about.html b/docs/_site/about.html new file mode 100644 index 00000000..51be1bb4 --- /dev/null +++ b/docs/_site/about.html @@ -0,0 +1,318 @@ + + + + + + + + About - Gancio + + + + + + + + + + + + + + + + + + + + +About | Gancio + + + + + + + + + + + + + + + +
    +
    + Gancio + +
    + + +
    +
    +

    This site uses Just the Docs, a documentation theme for Jekyll.

    +
    +
    +
    +
    +
    + +
    +
    + + Search +
    +
    +
    + + + + +
    +
    +
    + + + +
    +

    About

    + +

    Gancio was born in Italy from political hacking movements, in particular from the hacklab underscore. +We deal not only with technology but also with politics because we believe that technology is not neutral, that the Internet can also become an instrument of oppression, that information and software must be free and that knowledge is not for sale. For us, hacking is study and sharing, it is conscious and unconventional use of tools.

    + +

    In 2018 we set up a “radical local server” cisti.org that hosts services explicitly designed for local people / movements / groups / collectives and it is NOT our intention to grow. In fact, we believe that one of the main issues of technology is the scale.

    + +

    We liked very much the idea of the federation and following the example of our brothers and sisters in bologna (the bida.im collective) we setup a mastodon instance as a first service.

    + +

    The next step was to host a shared calendar, but as we didn’t find anything that would fit, we decided to write it ourselves.

    + + + +
    +
    +
    +
    + + + diff --git a/docs/_site/assets/css/style.css b/docs/_site/assets/css/style.css new file mode 100644 index 00000000..b6489864 --- /dev/null +++ b/docs/_site/assets/css/style.css @@ -0,0 +1,12 @@ +.navigation-list-item { + font-size: 18px !important; + padding: 4px; +} + +.navigation-list-item a { + color: blue; +} + +.navigation-list-item a:hover { + color: black; +} diff --git a/docs/_site/assets/js/search-data.json b/docs/_site/assets/js/search-data.json index cab08cc9..9f43b0f6 100644 --- a/docs/_site/assets/js/search-data.json +++ b/docs/_site/assets/js/search-data.json @@ -8,76 +8,90 @@ }, "1": { "id": "1", + "title": "About", + "content": "About Gancio was born in Italy from political hacking movements, in particular from the hacklab underscore. We deal not only with technology but also with politics because we believe that technology is not neutral, that the Internet can also become an instrument of oppression, that information and software must be free and that knowledge is not for sale. For us, hacking is study and sharing, it is conscious and unconventional use of tools. In 2018 we set up a “radical local server” cisti.org that hosts services explicitly designed for local people / movements / groups / collectives and it is NOT our intention to grow. In fact, we believe that one of the main issues of technology is the scale. We liked very much the idea of the federation and following the example of our brothers and sisters in bologna (the bida.im collective) we setup a mastodon instance as a first service. The next step was to host a shared calendar, but as we didn’t find anything that would fit, we decided to write it ourselves.", + "url": "https://gancio.org/about", + "relUrl": "/about" + }, + "2": { + "id": "2", "title": "Configuration", "content": "Configuration Main gancio configuration is done with a configuration file. This shoud be a .json or a .js file and could be specified using the --config flag. eg. gancio start --config ./config.json eg. pm2 start gancio start -- --config ~/config.json Title Description BaseURL Server Database Upload path SMTP Admin_email Favicon User locale Secret Default settings Title The title will be in rss feed, in html head and in emails: "title": "Gancio" Description "description": "a shared agenda for local communities" BaseURL URL where your site will be accessible (include http or https): "baseurl": "https://gancio.cisti.org" Server This probably support unix socket too :D "server": { "host": "localhost", "port": 13120 } Database DB configuration, look here for options. "db": { "dialect": "sqlite", "storage": "/tmp/db.sqlite" } Upload path Where to save images "upload_path": "./uploads" SMTP SMTP configuration. Gancio should send emails at following events: the admin should receive emails of anon event (if enabled) to confirm them. the admin should receive emails of registration request (if enabled) to confirm them. an user should receive an email of registration requested. an user should receive an email of confirmed registration. an user should receive a confirmation email when subscribed directly by admin. "smtp": { "auth": { "user": "", "pass": "" }, "secure": true, "host": "" } Admin_email Email of administrator. Note that email from gancio comes from this email and that the SMTP configuration above should allow to use this address as from. Favicon You could specify another favicon. This is also used as logo (top-left corner): "favicon": "./favicon.ico" User locale Probably you want to modify some text for your specific community, that’s why we thought the user_locale configuration: you can specify your version of each string of gancio making a directory with your locales inside. For example, let’s say you want to modify the text inside the /about page: mkdir /opt/gancio/user_locale put something like this in /opt/gancio/user_locale/en.js to override the about in english: export default { about: 'A new about' } and then point the user_locale configuration to that directory: "user_locale": "/opt/gancio/user_locale" Watch here for a list of strings you can override. :warning: Note that a restart is needed when you change user_locale’s content. Secret Default settings { "title": "Gancio", "description": "A shared agenda for local communities", "baseurl": "http://localhost:13120", "server": { "host": "0.0.0.0", "port": 13120 }, "db": { "dialect": "sqlite", "storage": "/tmp/db.sqlite" }, "upload_path": "./", "favicon": "../dist/favicon.ico", "smtp": { "auth": { "user": "", "pass": "" }, "secure": true, "host": "" }, "admin_email": "", "secret": "notsosecret" }", "url": "https://gancio.org/config", "relUrl": "/config" }, - "2": { - "id": "2", + "3": { + "id": "3", "title": "Debian", "content": "Debian installation Install Node.js & 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 "deb https://dl.yarnpkg.com/debian/ stable main" > /etc/apt/sources.list.d/yarn.list apt-get update && 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 'gancio'; 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" }, - "3": { - "id": "3", + "4": { + "id": "4", "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" }, - "4": { - "id": "4", + "5": { + "id": "5", "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" }, - "5": { - "id": "5", + "6": { + "id": "6", + "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" + }, + "7": { + "id": "7", "title": "Home", - "content": "Gancio A shared agenda for local communities. Get started now Demo Source Features Very easy UI User registration (you can follow them from fediverse personally or follow the whole instance with a special user) Support anonymous event (admin confirmation needed) Multidays events support (festival, conferences…) Recurrent events support (each monday, each two monday, each monday and friday, each first of month, each first monday of month, etc..) Filters events for tags or places RSS and ICS export (with filters) embeddable iframe (example) boost / bookmark / comment events from mastodon! Lot of configurations available (user registration open/close, enable AP federation, enable recurrent events) About the project Gancio is made with :heart: by hacklab underscore License Gancio is distributed by an AGPL-3.0 Licence.", + "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 anononymous event. Anononymous 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.", "url": "https://gancio.org/", "relUrl": "/" }, - "6": { - "id": "6", + "8": { + "id": "8", "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 & contribute", "url": "https://gancio.org/install", "relUrl": "/install" }, - "7": { - "id": "7", + "9": { + "id": "9", "title": "Instances", "content": "Instances gancio.cisti.org (Torino, Italy) lapunta.org (Firenze, Italy)", "url": "https://gancio.org/instances", "relUrl": "/instances" }, - "8": { - "id": "8", + "10": { + "id": "10", "title": "Support a new language", "content": "Add a new locale watch this commit", "url": "https://gancio.org/dev/locales", "relUrl": "/dev/locales" }, - "9": { - "id": "9", + "11": { + "id": "11", "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" }, - "10": { - "id": "10", + "12": { + "id": "12", "title": "Nginx", "content": "Nginx proxy configuration This is the default nginx configuration for gancio, please modify at least the server_name and ssl_certificate’s path. Note that this does not include a cache configuration and that gancio does not use a cache control at all, if you can help with this task you’re welcome. server { listen 80; listen [::]:80; server_name gancio.cisti.org; root /var/www/letsencrypt; location /.well-known/acme-challenge/ { allow all; } location / { return 301 https://$host$request_uri; } } server { listen 443 ssl http2; listen [::]:443 ssl http2; server_name gancio.cisti.org; ssl_protocols TLSv1.2; ssl_ciphers HIGH:!MEDIUM:!LOW:!aNULL:!NULL:!SHA; ssl_prefer_server_ciphers on; ssl_session_cache shared:SSL:10m; # Uncomment these lines once you acquire a certificate: # ssl_certificate /etc/letsencrypt/live/gancio.cisti.org/fullchain.pem; # ssl_certificate_key /etc/letsencrypt/live/gancio.cisti.org/privkey.pem; keepalive_timeout 70; sendfile on; client_max_body_size 80m; gzip on; gzip_disable "msie6"; gzip_vary on; gzip_proxied any; gzip_comp_level 6; gzip_buffers 16 8k; gzip_http_version 1.1; gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; add_header Strict-Transport-Security "max-age=31536000"; location / { try_files $uri @proxy; } location @proxy { proxy_set_header Host $host; proxy_set_header X-Forwarded-Proto https; proxy_set_header Proxy ""; proxy_pass_header Server; proxy_pass http://127.0.0.1:13120; proxy_buffering on; proxy_redirect off; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection $connection_upgrade; tcp_nodelay on; } }", "url": "https://gancio.org/install/nginx", "relUrl": "/install/nginx" }, - "11": { - "id": "11", + "13": { + "id": "13", "title": "Project Structure", "content": "Project structure API / backend Client / frontend Federation / ActivityPub API / backend Source code inside server/api/. index.js is basically a routing table pointing each PATH with specified HTTP VERB to a method of a controller. jwt is used to authenticate api request. Express.js is based on middleware, passing each request to a chain of methods. If you come from a PHP background, note that the main difference with Node.js is that the server process is always running and able to manage multiple requests and tasks together (asyncronically) while each php process is tied to a single request. Sequelize is used as ORM. Take a look in /server/api/models. Client / frontend Nuxt.js is used here! Nuxt is basically Vue plus SSR (Server Side Rendering). Client routing in nuxt is automatic (if you don’t need something special), just put your page inside pages and that’s it! Federation / ActivityPub Code inside server/federation.", "url": "https://gancio.org/dev/structure", diff --git a/docs/_site/config.html b/docs/_site/config.html index 4d8a31d4..1cff10d1 100644 --- a/docs/_site/config.html +++ b/docs/_site/config.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@type":"WebPage","url":"https://gancio.org/config","headline":"Configuration","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -253,9 +282,11 @@ @@ -266,7 +297,7 @@
    -

    Configuration

    +

    Configuration

    Main gancio configuration is done with a configuration file. This shoud be a .json or a .js file and could be specified using the --config flag.

    diff --git a/docs/_site/dev.html b/docs/_site/dev.html index fd214b3c..6717b348 100644 --- a/docs/_site/dev.html +++ b/docs/_site/dev.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@type":"WebPage","url":"https://gancio.org/dev","headline":"Hacking","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -252,9 +281,11 @@ @@ -344,6 +375,10 @@ + + + + diff --git a/docs/_site/dev/locales.html b/docs/_site/dev/locales.html index bee56ae7..9ab0d5b2 100644 --- a/docs/_site/dev/locales.html +++ b/docs/_site/dev/locales.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@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"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -252,9 +281,11 @@ diff --git a/docs/_site/dev/migration.html b/docs/_site/dev/migration.html index 6216443f..f068c838 100644 --- a/docs/_site/dev/migration.html +++ b/docs/_site/dev/migration.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@type":"WebPage","url":"https://gancio.org/dev/migration","headline":"Migration","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -252,9 +281,11 @@ diff --git a/docs/_site/dev/structure.html b/docs/_site/dev/structure.html index a48e4dad..ea61733a 100644 --- a/docs/_site/dev/structure.html +++ b/docs/_site/dev/structure.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@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"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -252,9 +281,11 @@ diff --git a/docs/_site/federation.html b/docs/_site/federation.html new file mode 100644 index 00000000..fb7b5f93 --- /dev/null +++ b/docs/_site/federation.html @@ -0,0 +1,317 @@ + + + + + + + + Federation - Gancio + + + + + + + + + + + + + + + + + + + + +Federation | Gancio + + + + + + + + + + + + + + + +
    +
    + Gancio + +
    + + +
    +
    +

    This site uses Just the Docs, a documentation theme for Jekyll.

    +
    +
    +
    +
    +
    + +
    +
    + + Search +
    +
    +
    + + + + +
    +
    +
    + + + +
    +

    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.

    + + + +
    +
    +
    +
    + + + diff --git a/docs/_site/feed.xml b/docs/_site/feed.xml index 5461bbc6..f77e91a2 100644 --- a/docs/_site/feed.xml +++ b/docs/_site/feed.xml @@ -1 +1 @@ -Jekyll2019-11-14T12:21:49+01:00https://gancio.org/feed.xmlGancioA shared agenda for local communities \ No newline at end of file +Jekyll2019-12-04T01:12:29+01:00https://gancio.org/feed.xmlGancioA shared agenda for local communities with AP support \ No newline at end of file diff --git a/docs/_site/index.html b/docs/_site/index.html index cef58f84..8b1b4a12 100644 --- a/docs/_site/index.html +++ b/docs/_site/index.html @@ -13,6 +13,7 @@ + @@ -148,6 +149,10 @@ + + + + @@ -215,6 +220,10 @@ + + + + @@ -231,6 +240,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -246,8 +275,7 @@
    - Search - + Search
    @@ -255,9 +283,11 @@ @@ -266,37 +296,44 @@
    -

    - Gancio

    +

    Gancio

    A shared agenda for local communities.

    Get started now Demo Source

    -

    assets/thumbs/home1.png -assets/thumbs/mobile1.png -assets/thumbs/mobile2.png -assets/thumbs/admin_users.png

    +

    assets/thumbs/home1.png +assets/thumbs/mobile1.png +assets/thumbs/mobile2.png +assets/thumbs/admin_users.png

    + +

    Some relevant key features:

    -

    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 anononymous event.

      +
      • +
    • +

      Anononymous 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
      • -
    • User registration (you can follow them from fediverse personally or follow the whole instance with a special user)
      • -
    • Support anonymous event (admin confirmation needed)
    • Multidays events support (festival, conferences…)
      • -
    • Recurrent events support (each monday, each two monday, each monday and friday, each first of month, each first monday of month, etc..)
      • +
    • 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 mastodon!
      • -
    • Lot of configurations available (user registration open/close, enable AP federation, enable recurrent events)
      • +
    • embeddable iframe (example)
      • +
    • boost / bookmark / comment events from the fediverse!
      • +
    • Lot of configurations available (user registration open/close, enable federation, enable recurrent events)
    -

    About the project

    - -

    Gancio is made with :heart: by hacklab underscore

    -

    License

    Gancio is distributed by an AGPL-3.0 Licence.

    diff --git a/docs/_site/install.html b/docs/_site/install.html index fee04f41..be401093 100644 --- a/docs/_site/install.html +++ b/docs/_site/install.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@type":"WebPage","url":"https://gancio.org/install","headline":"Install","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -252,9 +281,11 @@ @@ -265,7 +296,7 @@
    -

    Install (production)

    +

    Install (production)

    • Install on Debian
      • diff --git a/docs/_site/install/debian.html b/docs/_site/install/debian.html index a8d55671..eb009961 100644 --- a/docs/_site/install/debian.html +++ b/docs/_site/install/debian.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@type":"WebPage","url":"https://gancio.org/install/debian","headline":"Debian","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"} @@ -146,6 +147,10 @@ + + + +
    @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -252,9 +281,11 @@ diff --git a/docs/_site/install/docker.html b/docs/_site/install/docker.html index c08cd74c..47eda038 100644 --- a/docs/_site/install/docker.html +++ b/docs/_site/install/docker.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@type":"WebPage","url":"https://gancio.org/install/docker","headline":"Docker","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -253,9 +282,11 @@ diff --git a/docs/_site/install/nginx.html b/docs/_site/install/nginx.html index 9029bb1e..5341a62d 100644 --- a/docs/_site/install/nginx.html +++ b/docs/_site/install/nginx.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@type":"WebPage","url":"https://gancio.org/install/nginx","headline":"Nginx","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -252,9 +281,11 @@ diff --git a/docs/_site/instances.html b/docs/_site/instances.html index d98da239..7c6feecc 100644 --- a/docs/_site/instances.html +++ b/docs/_site/instances.html @@ -11,6 +11,7 @@ + @@ -29,13 +30,13 @@ - - + + +{"@type":"WebPage","url":"https://gancio.org/instances","headline":"Instances","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"} @@ -146,6 +147,10 @@ + + + + @@ -213,6 +218,10 @@ + + + + @@ -229,6 +238,26 @@ + + +
  • + + About + +
    • + + + + + +
  • + + Federation + +
    • + + + @@ -252,9 +281,11 @@ diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 00000000..a607683a --- /dev/null +++ b/docs/about.md @@ -0,0 +1,16 @@ +--- +layout: default +title: About +permalink: /about +nav_order: 8 +--- +## About + +Gancio was born in Italy from political hacking movements, in particular from the [hacklab underscore](https://autistici.org/underscore). +We deal not only with technology but also with politics because we believe that technology is not neutral, that the Internet can also become an instrument of oppression, that information and software must be free and that knowledge is not for sale. For us, hacking is study and sharing, it is conscious and unconventional use of tools. + +In 2018 we set up a “radical local server” [cisti.org](https://cisti.org) that hosts services explicitly designed for local people / movements / groups / collectives and it is NOT our intention to grow. In fact, we believe that one of the main issues of technology is the scale. + +We liked very much the idea of the federation and following the example of our brothers and sisters in bologna (the [bida.im](https://bida.im) collective) we setup a mastodon instance as a first service. + +The next step was to host a shared calendar, but as we didn't find anything that would fit, we decided to write it ourselves. diff --git a/docs/assets/css/style.css b/docs/assets/css/style.css new file mode 100644 index 00000000..b6489864 --- /dev/null +++ b/docs/assets/css/style.css @@ -0,0 +1,12 @@ +.navigation-list-item { + font-size: 18px !important; + padding: 4px; +} + +.navigation-list-item a { + color: blue; +} + +.navigation-list-item a:hover { + color: black; +} diff --git a/docs/configuration.md b/docs/configuration.md index ab9d77d7..4a87299f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -5,7 +5,7 @@ permalink: /config nav_order: 3 --- -# Configuration +## Configuration {: .no_toc } Main `gancio` configuration is done with a configuration file. This shoud be a `.json` or a `.js` file and could be specified using the `--config` flag. diff --git a/docs/federation.md b/docs/federation.md new file mode 100644 index 00000000..3a7ab8d7 --- /dev/null +++ b/docs/federation.md @@ -0,0 +1,16 @@ +--- +layout: default +title: Federation +permalink: /federation +nav_order: 9 +--- + +## Federation + +Each instance has only one [AP Actor](https://www.w3.org/TR/activitypub/#actors) 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. diff --git a/docs/index.md b/docs/index.md index 9a567f36..e7d2dd26 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,21 +21,25 @@ A shared agenda for local communities. [![assets/thumbs/admin_users.png](assets/thumbs/admin_users.png)](assets/admin_users.png){: data-fancybox="group" data-caption="Admin interface"} -## Features +## 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 anononymous event. + +- **Anononymous 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 -- User registration (you can follow them from fediverse personally or follow the whole instance with a special user) -- Support anonymous event (admin confirmation needed) - Multidays events support (festival, conferences...) -- Recurrent events support (each monday, each two monday, each monday and friday, each first of month, each first monday of month, etc..) +- 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](https://gancio.cisti.org/embed/list?title=Upcoming events)) -- boost / bookmark / comment events from mastodon! -- Lot of configurations available (user registration open/close, enable AP federation, enable recurrent events) - -### About the project - -Gancio is made with :heart: by [hacklab underscore](https://autistici.org/underscore) +- boost / bookmark / comment events from the fediverse! +- Lot of configurations available (user registration open/close, enable federation, enable recurrent events) ### License diff --git a/docs/install/install.md b/docs/install/install.md index 4d8d891f..55dc5b81 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -7,7 +7,7 @@ nav_order: 2 has_toc: false --- -# Install (production) +## Install (production) - [Install on Debian](/install/debian) - [Install using docker](/install/docker)