usage.rst

Usage
=====

Stackspin User panel
--------------------

After all the applications are installed, the first thing to do is log into
`https://admin.stackspin.example.org <https://admin.stackspin.example.org>`__.
This is the "user panel" , a place where you can create, edit and delete users.
These users can be used to log into the applications listed below.
You can log in with the user "admin". The password can be found by running

.. code:: bash

   python3 -m stackspin stackspin.example.org secrets

Search for ``userbackend_admin_password``.

After logging in, you will see an overview of all the installed applications
your user has access to. For more information on how to create users and give
them access to applications, take a look at the `user panel documentation
<https://docs.stackspin.net/projects/user-panel/en/latest>`_.

.. note::

   If you don't see applications, make sure you have installed at least one
   optional application in :ref:`additional_apps` of the installation procedure.

For creating users follow the `user creation documentation
<https://docs.stackspin.net/projects/user-panel/en/latest/#creating-a-new-user>`_.

*Note*: The email address is important because some applications need a valid
email address for notification mails.
Single sign-on with Grafana will fail for users lacking an email address.

You can now use the new user to log in to all apps which were granted access to
in the last step using single sign-on.

Links to all available apps are shown in the userpanel dashboard, which can
be used to access these apps without a need to bookmark all URLs.

Core applications
-----------------

These applications are available after the installation is completed
successfully:

Grafana
~~~~~~~

`Grafana <https://grafana.com>`__ is a dashboard application that shows you
information about the status of your cluster collected by `Prometheus
<https://prometheus.io>`__.

Single sign-on users
''''''''''''''''''''

Users that have the "Admin" label turned on in the user panel, will have admin
rights in Grafana. Other users are able to see graphs, but can not change
anything.

Optional applications
---------------------

Nextcloud
~~~~~~~~~

`Nextcloud <https://nextcloud.com/>`__ is a file sharing and communication
platform. These Nectcloud apps can be accessed from the top navigation bar:

Files & synchronization
'''''''''''''''''''''''

You can access your files with the Nextcloud Web interface and create,
preview, edit, delete, share, and re-share files.
See the `Files & synchronization user manual
<https://docs.nextcloud.com/server/latest/user_manual/en/files/index.html>`_ for
general usage and `Desktop and mobile synchronization
<https://docs.nextcloud.com/server/latest/user_manual/th/files/desktop_mobile_sync.html>`_
for setting up file sync on your mobile or dektop device.

Calendar
''''''''

The Nextcloud Calendar app works similar to other calendar applications you
can sync your Nextcloud calendars and events with.
Follow the `Calendar user manual
<https://docs.nextcloud.com/server/latest/user_manual/en/pim/calendar.html>`_
for general usage and the
`Nextcloud groupware docs <https://docs.nextcloud.com/server/latest/user_manual/th/pim/index.html>`
for syncing your calendars with your mobile or desktop devices.

Passwords
'''''''''

A simple, yet feature rich password manager for Nextcloud.
See `Passwors user handbook
<https://git.mdns.eu/nextcloud/passwords/wikis/users/index>`_
for more details, including using the `Browser extenstions
<https://git.mdns.eu/nextcloud/passwords/wikis/Users/Index#browser-extension>`_.

These are the mobile apps that you can use to access your passwords from your
smartphone:

* [NC passwords app for Android (by joleaf)](https://gitlab.com/joleaf/nc-passwords-app)
* [Nexcloud password app for Android (by daper)](https://github.com/daper/nextcloud-passwords-app)
* [Nextcloud passwords for iOS](https://github.com/johannes-schliephake/nextcloud-passwords-ios)

You'll find how to configure file or calendar sync with your smartphone or
desktop in the `Nextcloud Groupware documentation
<https://docs.nextcloud.com/server/latest/user_manual/th/pim/index.html>`_.

Onlyoffice
~~~~~~~~~~

`Onlyoffice <https://www.onlyoffice.com/connectors-nextcloud.aspx>`__ is an
online document editing suite. Your can open documents in Onlyoffice by clicking
them in Nextcloud. You can open new documents by clicking the "Plus" button in
Nextcloud and selecting Document, Spreadsheet or Presentation.

Zulip
~~~~~

`Zulip <https://zulip./>`__ is a team chat application.

Unfortunately, Zulip does not yet listen to the Stackspin roles, so once you
have installed Zulip, you need to make one of your users the owner. That allows
this user to manage Zulip's settings from inside the application. This owner
can also edit other users' roles.

For this, you have to replace ``<your email>`` in the the following command and
run it on your cluster:

```
kubectl exec -n stackspin-apps zulip-0 -c zulip -- sudo -u zulip /home/zulip/deployments/current/manage.py change_user_role <your email> owner --realm 2
```


Wekan
~~~~~

`Wekan <https://wekan.github.io>`__ is a Kanban board application.

WordPress
~~~~~~~~~

`WordPress <https://wordpress.com>`__ is a website content management system.