##################
Administration
##################

.. contents::
   :local:

Services
"""""""""""""""""

Commands to enable Opencelium services (already done on installation).

.. code-block:: sh

        ln -s /opt/scripts/oc_service.sh /usr/bin/oc
        
        ln -s /opt/opencelium/conf/opencelium.service /etc/systemd/system/opencelium.service 
        systemctl daemon-reload

**Available services:**

Frontend:

.. code-block:: sh

	systemctl start nginx
	systemctl stop nginx
	systemctl start nginx
	systemctl restart nginx 
	systemctl enable nginx
	systemctl disable nginx 

Backend:

.. code-block:: sh

	systemctl start opencelium
	systemctl stop opencelium
	systemctl start opencelium
	systemctl restart opencelium 
	systemctl enable opencelium
	systemctl disable opencelium 


Routing of the backend through an endpoint
"""""""""""""""""""""""""""""""""""""""""""

To change this routing you need to follow the next steps.

**1. Change routing in frontend:**

Create a settings.json file inside of frontend directory (usually underneath /opt/opencelium/src/frontend/) and change the settings to this.

.. code-block:: sh

	{
		"PORT": {
			"APPLICATION": "",
			"API": ""
		},
		"SERVER_ENDPOINT": "/api/"
	}

**2. Add proxy in the webserver config:**

Open the settings of your webserver (usually it is nginx) and add the follow config:

.. code-block:: sh

	# Activate Proxy
	location /api/ {
		# Routing of all requests to /api to the backend server. pls replace {localhost}
		proxy_pass http://localhost:9090/;

		#Set proxy header
		proxy_set_header X-Forwarded-For $remote_addr;
		proxy_set_header X-Forwarded-Proto http;

		# Optional: CORS headers
		add_header Access-Control-Allow-Origin "*";
		add_header Access-Control-Allow-Methods "GET, POST, PUT, DELETE, OPTIONS";
		add_header Access-Control-Allow-Headers "Content-Type, Authorization";

		# Handle preflight requests
		if ($request_method = OPTIONS) {
			add_header Content-Length 0;
			add_header Content-Type text/plain;
			return 204;
		}
	}

.. note::
	| You can get the webserver configs for nginx and apache2 underneath the conf directory.
	|  
	| https://github.com/opencelium/opencelium/tree/prod/conf

**3. Restart your webserver:**

.. code-block:: sh

	systemctl restart nginx


Check health
"""""""""""""""""

Check status of opencelium service

.. code-block:: sh

	systemctl status nginx
	systemctl status opencelium
	
	
Autostart
"""""""""""""""""

Start opencelium services automatically on system start

.. code-block:: sh

	systemctl enable nginx
	systemctl enable opencelium
	

.. _getting_started-administration-logging:

Logging
"""""""

| If you want to have a look into OpenCelium Logs please use:

.. code-block:: sh
	:linenos:
	
	journalctl -xe -u opencelium -o cat -f


Backup
"""""""""""""""""

To create a local backup of your OpenCelium installation, please execute the following command as root.
Old backups will be removed after 14 days.

.. note::
	Please change the password (secret1234) in the following command line!

.. code-block:: sh

	oc backup -d /var/backups/opencelium -u opencelium -p secret1234

| This will include:
| - MySQL database dump
| - MongoDB database dump
| - backup of the installation directory /opt/opencelium/


Restore
"""""""""""""""""

We decided not to provide an automatic functionallity for the restore process, because it's mostly not needed to restore everything
at once.

**Extract the backup:**

.. code-block:: sh

	mkdir /var/backups/opencelium/restore
	ls -l /var/backups/opencelium

.. note::
	Please change the <backup filename> in the following command line!

.. code-block:: sh	
	
	tar xf /var/backups/opencelium/<backup filename>.tar.gz -C /var/backups/opencelium/restore/ --strip-components=4


**Restore MySQL database: (Connectors, Connections and Schedules)**

.. note::
	Please change the password (secret1234) in the following command line!

.. code-block:: sh

	mysql -uopencelium -psecret1234 opencelium < /var/backups/opencelium/restore/oc_data.sql


**Restore MongoDB database (Connection details)**

.. code-block:: sh

	mongorestore --drop --db opencelium /var/backups/opencelium/restore/opencelium/


**Restore files and folders: (all programm files, invokers and templates)**

In case you have to replace single files and folders, you will find all backuped files within the extracted
backup in /var/backups/opencelium/restore/opt-backup .