geolba/tethys
6
0
Fork 0
Code Issues 2 Pull Requests Packages Projects 1 Releases Wiki Activity

Update 'Home'

Kaimbacher 2022-08-11 09:52:32 +00:00
parent a6077279bf
commit c8a5abfab2
1 changed files with 213 additions and 213 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

426
Home.md

@ -1,213 +1,213 @@
# Home # Home
**TETHYS** - Data Publisher for Geoscience Austria is a digital data library and a data publisher for earth system science. Data can be georeferenced in time (date/time) and space (latitude, longitude, depth/height) **TETHYS** - Data Publisher for Geoscience Austria is a digital data library and a data publisher for earth system science. Data can be georeferenced in time (date/time) and space (latitude, longitude, depth/height)
## Getting Started ## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Step1: install required system tools and programming languages ### Step1: install required system tools and programming languages
* [System Tools Installation (Ubuntu)](SystemToolsUbuntu) * [System Tools Installation (Ubuntu)](SystemToolsUbuntu)
### Step 2. install PostgreSQL database ### Step 2. install PostgreSQL database
* [PostgreSQL Installation an database creation (Ubuntu)](PostgreSqlUbuntu) * [PostgreSQL Installation an database creation (Ubuntu)](#PostgreSqlUbuntu)
### Step 3. install and configure Solr ### Step 3. install and configure Solr
* [Solr on Ubuntu](SolrUbuntu) * [Solr on Ubuntu](SolrUbuntu)
### Step 4. Download and Install Tethys ### Step 4. Download and Install Tethys
Please check the official laravel installation guide for server requirements before you start. [Official Documentation](https://laravel.com/docs/6.x/installation#installation) Please check the official laravel installation guide for server requirements before you start. [Official Documentation](https://laravel.com/docs/6.x/installation#installation)
Create web folder:\ Create web folder:\
`sudo mkdir -p /var/www/tethys-app/` `sudo mkdir -p /var/www/tethys-app/`
`sudo chown -R administrator:administrator /var/www/tethys-app/` `sudo chown -R administrator:administrator /var/www/tethys-app/`
Clone the repository to your web folder:\ Clone the repository to your web folder:\
`git clone https://github.com/geolba/tethys.git /var/www/tethys-app/` `git clone https://github.com/geolba/tethys.git /var/www/tethys-app/`
Switch to the repo folder:\ Switch to the repo folder:\
`cd /var/www/tethys-app/` `cd /var/www/tethys-app/`
Install all the dependencies using composer Install all the dependencies using composer
`composer install --optimize-autoloader --no-dev` `composer install --optimize-autoloader --no-dev`
Copy the example env file and make the required configuration changes in the .env file Copy the example env file and make the required configuration changes in the .env file
`cp .env.example .env` `cp .env.example .env`
`.env` - Environment variables can be set in this file `.env` - Environment variables can be set in this file
Configure your database connection in .env-file e.g.: Configure your database connection in .env-file e.g.:
`nano .env` `nano .env`
```ini ```ini
DB_CONNECTION=pgsql DB_CONNECTION=pgsql
DB_HOST=localhost DB_HOST=localhost
DB_PORT=5432 DB_PORT=5432
DB_DATABASE=tethys DB_DATABASE=tethys
DB_USERNAME=tethys_admin DB_USERNAME=tethys_admin
DB_PASSWORD=new_password_here DB_PASSWORD=new_password_here
DB_SCHEMA=gba DB_SCHEMA=gba
``` ```
also set the solr connection string: also set the solr connection string:
```ini ```ini
SOLR_HOST=localhost SOLR_HOST=localhost
SOLR_CORE=tethys_data SOLR_CORE=tethys_data
``` ```
***Note*** : You can quickly set the database information, the solr connection string and other variables in this file and have the application fully working. ***Note*** : You can quickly set the database information, the solr connection string and other variables in this file and have the application fully working.
Save and close the file and generate a new application key Save and close the file and generate a new application key
`php artisan key:generate` `php artisan key:generate`
Run the database migrations (**Set the database connection in .env before migrating**) Run the database migrations (**Set the database connection in .env before migrating**)
`php artisan migrate` `php artisan migrate`
Grant folder permissions for webserver user Grant folder permissions for webserver user
```ini ```ini
sudo chgrp -R www-data storage bootstrap/cache sudo chgrp -R www-data storage bootstrap/cache
sudo chmod -R ug+rwx storage bootstrap/cache sudo chmod -R ug+rwx storage bootstrap/cache
``` ```
## Local Development ## Local Development
To develop locally, you must run a local web server. To develop locally, you must run a local web server.
To run: To run:
`php artisan serve` `php artisan serve`
This will start the server on <http://localhost:8080> from the current working directory. This will start the server on <http://localhost:8080> from the current working directory.
stop the service: stop the service:
`Strg + C` `Strg + C`
## Nginx Configuration ## Nginx Configuration
`sudo nano /etc/nginx/sites-available/tethys-app` `sudo nano /etc/nginx/sites-available/tethys-app`
**http-only configuration:** **http-only configuration:**
```nginx ```nginx
server { server {
listen 80; listen 80;
listen [::]:80; listen [::]:80;
server_name localhost; server_name localhost;
root /var/www/tethys-app/public/; root /var/www/tethys-app/public/;
client_max_body_size 100M; client_max_body_size 100M;
index index.html index.htm index.php; index index.html index.htm index.php;
charset utf-8; charset utf-8;
add_header X-Frame-Options "SAMEORIGIN"; add_header X-Frame-Options "SAMEORIGIN";
add_header X-XSS-Protection "1; mode=block"; add_header X-XSS-Protection "1; mode=block";
add_header X-Content-Type-Options "nosniff"; add_header X-Content-Type-Options "nosniff";
location / { location / {
index index.php; index index.php;
try_files $uri $uri/ /index.php?$query_string; try_files $uri $uri/ /index.php?$query_string;
} }
location = /favicon.ico { access_log off; log_not_found off; } location = /favicon.ico { access_log off; log_not_found off; }
location = /robots.txt { access_log off; log_not_found off; } location = /robots.txt { access_log off; log_not_found off; }
error_page 404 /index.php; error_page 404 /index.php;
location ~ \.php$ { location ~ \.php$ {
fastcgi_pass unix:/var/run/php/php7.4-fpm.sock; fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
fastcgi_index index.php; fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name; fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
include fastcgi_params; include fastcgi_params;
include fastcgi.conf; include fastcgi.conf;
} }
location ~ /\.(?!well-known).* { deny all;} location ~ /\.(?!well-known).* { deny all;}
} }
``` ```
**alternate https and http configuration:** **alternate https and http configuration:**
```nginx ```nginx
server { server {
listen [::]:443 ssl http2; listen [::]:443 ssl http2;
listen 443 ssl http2; listen 443 ssl http2;
server_name localhost; server_name localhost;
root /var/www/tethys-app/public/; root /var/www/tethys-app/public/;
client_max_body_size 100M; client_max_body_size 100M;
index index.html index.htm index.php; index index.html index.htm index.php;
charset utf-8; charset utf-8;
# path to https-certificate # path to https-certificate
ssl_certificate /etc/ssl/your_domain.pem; ssl_certificate /etc/ssl/your_domain.pem;
ssl_certificate_key /etc/ssl/your_domain.key; ssl_certificate_key /etc/ssl/your_domain.key;
ssl_ciphers EECDH+CHACHA20:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5; ssl_ciphers EECDH+CHACHA20:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5;
add_header X-Frame-Options "SAMEORIGIN"; add_header X-Frame-Options "SAMEORIGIN";
add_header X-XSS-Protection "1; mode=block"; add_header X-XSS-Protection "1; mode=block";
add_header X-Content-Type-Options "nosniff"; add_header X-Content-Type-Options "nosniff";
location / { location / {
index index.php; index index.php;
try_files $uri $uri/ /index.php?$query_string; try_files $uri $uri/ /index.php?$query_string;
} }
location = /favicon.ico { access_log off; log_not_found off; } location = /favicon.ico { access_log off; log_not_found off; }
location = /robots.txt { access_log off; log_not_found off; } location = /robots.txt { access_log off; log_not_found off; }
error_page 404 /index.php; error_page 404 /index.php;
location ~ \.php$ { location ~ \.php$ {
fastcgi_pass unix:/var/run/php/php7.4-fpm.sock; fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
fastcgi_index index.php; fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name; fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
include fastcgi_params; include fastcgi_params;
include fastcgi.conf; include fastcgi.conf;
} }
location ~ /\.(?!well-known).* { deny all;} location ~ /\.(?!well-known).* { deny all;}
} }
server { server {
if ($host = repository.geologie.ac.at) { if ($host = repository.geologie.ac.at) {
return 301 https://$host$request_uri; return 301 https://$host$request_uri;
} }
listen 80; listen 80;
listen [::]:80; listen [::]:80;
server_name localhost; server_name localhost;
return 404; return 404;
} }
``` ```
symlinking the created site to enabled folder:\ symlinking the created site to enabled folder:\
`sudo ln -s /etc/nginx/sites-available/tethys-app /etc/nginx/sites-enabled/` `sudo ln -s /etc/nginx/sites-available/tethys-app /etc/nginx/sites-enabled/`
test nginx configuration:\ test nginx configuration:\
`sudo nginx -t` `sudo nginx -t`
if everything is successful, reload updated nginx configuration:\ if everything is successful, reload updated nginx configuration:\
`sudo service nginx reload` `sudo service nginx reload`
The website is available at the following link: <http://localhost:80> The website is available at the following link: <http://localhost:80>
## Requesting https-certificate ## Requesting https-certificate
`sudo certbot certonly --nginx --webroot-path=/var/www/tethys-app/ -d www.your_domain.at -d your_domain.at` `sudo certbot certonly --nginx --webroot-path=/var/www/tethys-app/ -d www.your_domain.at -d your_domain.at`
Adapt the settings 'ssl_certificate' and 'ssl_certificate_key' in the following file /etc/nginx/sites-available/tethys-app:\ Adapt the settings 'ssl_certificate' and 'ssl_certificate_key' in the following file /etc/nginx/sites-available/tethys-app:\
`sudo nano /etc/nginx/sites-available/tethys-app` `sudo nano /etc/nginx/sites-available/tethys-app`
```nginx ```nginx
ssl_certificate /etc/letsencrypt/live/www.your_domain.at/fullchain.pem; ssl_certificate /etc/letsencrypt/live/www.your_domain.at/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/www.your_domain.at/privkey.pem; ssl_certificate_key /etc/letsencrypt/live/www.your_domain.at/privkey.pem;
``` ```
Certbot will autmatically renew outdated certificates. Sytemd services 'cerbot.service' and 'certbot.timer' are checking twice daily whether certificates have been expired. Certbot will autmatically renew outdated certificates. Sytemd services 'cerbot.service' and 'certbot.timer' are checking twice daily whether certificates have been expired.