update docs
This commit is contained in:
lesion
@@ -16,9 +16,9 @@
|
||||
"2": {
|
||||
"id": "2",
|
||||
"title": "Classic",
|
||||
"content": "Classic setup Install Node.js and postgreSQL curl -sL https://deb.nodesource.com/setup_12.x | bash - apt-get install -y nodejs postgresql source Install Gancio npm install --global gancio Create a database (optional as you can use sqlite, but recommended) sudo -u postgres 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 Test & launch interactive setup gancio --help gancio setup --config config.json Start gancio --help gancio start --config config.json Point your web browser to http://localhost:13120 or where you selected during setup. Setup nginx as a proxy Deploy in production If you don’t use the docker way, in production you should use something like pm2: sudo npm install --global pm2 pm2 gancio start --config config.json",
|
||||
"url": "https://gancio.org/setup/classic",
|
||||
"relUrl": "/setup/classic"
|
||||
"content": "Install Install Node.js and postgreSQL curl -sL https://deb.nodesource.com/setup_12.x | bash - apt-get install -y nodejs postgresql source Install Gancio npm install --global gancio Create a database (optional as you can use sqlite, but recommended) sudo -u postgres 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 Test & launch interactive setup gancio --help gancio setup --config config.json Start gancio --help gancio start --config config.json Point your web browser to http://localhost:13120 or where you selected during setup. Setup nginx as a proxy Deploy in production If you don’t use the docker way, in production you should use something like pm2: sudo npm install --global pm2 pm2 gancio start --config config.json",
|
||||
"url": "https://gancio.org/install/classic",
|
||||
"relUrl": "/install/classic"
|
||||
},
|
||||
"3": {
|
||||
"id": "3",
|
||||
@@ -45,8 +45,8 @@
|
||||
"id": "6",
|
||||
"title": "Docker",
|
||||
"content": "Install with docker You do not need to clone the full repo as we distribute gancio via npm. Dockerfile and docker-compose.yml are the only needed files. Create a directory where everything related to gancio is stored (db, images, config) mkdir /opt/gancio cd /opt/gancio :information_source: you can choose a different directory of course Download docker-compose.yml and Dockerfile wget https://git.lattuga.net/cisti/gancio/raw/docker/docker/Dockerfile wget https://git.lattuga.net/cisti/gancio/raw/docker/docker/docker-compose.yml Create an empty configuration file touch config.json After first setup, you can modify this file and restart the container on your needs. Build docker image and launch interactive setup in one step docker-compose run --rm gancio gancio setup Run your container docker-compose up -d Setup nginx as a proxy Point your web browser to http://localhost:13120 or where you specified during setup and enjoy :tada:",
|
||||
"url": "https://gancio.org/setup/docker",
|
||||
"relUrl": "/setup/docker"
|
||||
"url": "https://gancio.org/install/docker",
|
||||
"relUrl": "/install/docker"
|
||||
},
|
||||
"7": {
|
||||
"id": "7",
|
||||
@@ -57,31 +57,31 @@
|
||||
},
|
||||
"8": {
|
||||
"id": "8",
|
||||
"title": "Install",
|
||||
"content": "Install Classic install Using docker Nginx as a proxy Hacking & contribute",
|
||||
"url": "https://gancio.org/install",
|
||||
"relUrl": "/install"
|
||||
},
|
||||
"9": {
|
||||
"id": "9",
|
||||
"title": "Instances",
|
||||
"content": "Instances gancio.cisti.org (Torino, Italy) lapunta.org (Firenze, Italy)",
|
||||
"url": "https://gancio.org/instances",
|
||||
"relUrl": "/instances"
|
||||
},
|
||||
"9": {
|
||||
"id": "9",
|
||||
"10": {
|
||||
"id": "10",
|
||||
"title": "Migration",
|
||||
"content": "Migration If you need to modify the db’s structure while hacking, it’s super easy, just change server/api/models/. If you then decide that your changes are good for production, a sequelize migration is needed: Create a migration: ./node_modules/.bin/sequelize migration:generate --name your_migration",
|
||||
"url": "https://gancio.org/dev/migration",
|
||||
"relUrl": "/dev/migration"
|
||||
},
|
||||
"10": {
|
||||
"id": "10",
|
||||
"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 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/setup/nginx",
|
||||
"relUrl": "/setup/nginx"
|
||||
},
|
||||
"11": {
|
||||
"id": "11",
|
||||
"title": "Setup",
|
||||
"content": "Setup Setup with docker Classic setup Nginx as a proxy Hacking & contribute",
|
||||
"url": "https://gancio.org/setup",
|
||||
"relUrl": "/setup"
|
||||
"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"
|
||||
},
|
||||
"12": {
|
||||
"id": "12",
|
||||
|
||||
Reference in New Issue
Block a user