diff --git a/docs/installation_instructions.md b/docs/installation_instructions.md index bd45d03718683a392036680cda946d855bb90938..5d63bbe941bab79501b72c0a1c9efc73eab656b1 100644 --- a/docs/installation_instructions.md +++ b/docs/installation_instructions.md @@ -31,7 +31,7 @@ guide][https://openappstack.net/contact.html). ## Prerequisites -* During these instructions, you are asked to make a VPS, or have a bare metal +* During these instructions, you are asked to create a VPS, or have a bare metal server ready. The server should meet these requirements: * Current Debian stable "buster" * A public IP address @@ -40,14 +40,15 @@ guide][https://openappstack.net/contact.html). * At least 25GB of disk space for installation, plus more for application data. We recommend starting with 30GB. * Root ssh access - * `python3` installed + * `python3` installed. On a debian based system: - `apt install python3-pip` + `apt install python3` * A trusted machine to run the installer on (we call this the `provisioning machine`). All the commands listed in these instructions should be run on the provisioning machine, unless specified otherwise. - * You need Python 3 with it's development files, Pip and Git installed (`apt install python3-pip python3-dev git`) + * You need Python 3 with it's development files, Pip and Git installed + (`apt install python3-pip python3-dev git`) * We recommend using a [python virtualenv](https://docs.python.org/3/tutorial/venv.html) to make sure we do not change any of your other projects. Install virtualenv by running `pip3 install --user venv` or `apt install python3-venv` @@ -269,8 +270,9 @@ the `openappstack` CLI tool. OpenAppStack uses [Flux](https://fluxcd.io) to install applications. After the installation process has compleded, Flux has not necessarily finished installing -and integrating all the applications. This process can take up to a few hours to -complete. +and integrating all the applications. This process usually takes 10-20 minutes +to complete, but can also take longer depending on your machine's compute and/or +network resources. In the future, we will add commands that show you the status of the application installation. For now, just wait half an hour for everything to settle, and then @@ -291,12 +293,13 @@ went well. ## Usage After all the applications are installed, the first thing to do is log into -admin.oas.example.org. Here you can find the "user panel", a place where you can -create, edit and delete users. You can log in with the user "admin". The +https://admin.oas.example.org. Here you can find the "user panel", a place where +you can create, edit and delete users. You can log in with the user "admin". The password can be found in `clusters/my-cluster/secrets/userbackend_admin_password`. After logging in, you will see an overview of all the applications your user has access to. For more -information, take a look at the [user panel +information on how to create users and give them access to applications, take a +look at the [user panel documentation](https://docs.openappstack.net/projects/user-panel/en/latest/). > **NOTE:** at the moment none of the applications are available at @@ -334,6 +337,10 @@ These applications should be available after the installation is completed: - Single sign-on is still in an experimental phase. We are still working on transferring "roles" from users in the central database to applications, so your SSO's admin user gets admin permissions in all the applications. + - This means that if you need to login as an Admin user, you need to use the + admin credentials in `clusters/my-cluster/secrets/<app_admin_password>`. + - To use single sign-on with Grafana, your user *needs* to have an email + address set in the user database. - Nextcloud does not send emails yet. You can configure sending emails by going to Settings -> Basic settings -> Email server and entering SMTP email credentials.