mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-03-05 04:20:52 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added and fixed ubernauten.md plus image and video file referenced.

Browse Source 
Someone who knows Markdown, Styleguide and stuff better than me should
correct that file.
This commit is contained in:
mfeilner
2023-12-04 22:55:08 +01:00
parent 91c43fe4ca
commit bff7a2010d
3 changed files with 86 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/ocis/deployment/001-OCIS-in-50-seconds-2023-10-17.mkv Normal file
View File

Binary file not shown.

BIN
docs/ocis/deployment/login.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 209 KiB

153
docs/ocis/deployment/ubernauten.md
View File

@@ -1,53 +1,59 @@
Uberspace and ownCloud Infinite Scale in 50 seconds
---------------------------------------------------
---
title: "Installing Infinite Scale at Ubernauten"
date: 2023-12-04T14:04:00+01:00
weight: 100
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/ocis/deployment
geekdocFilePath: ubernauten.md
---
[comment]: # Is there a style guide?
[comment]: # How to do inline URLs and where to put the videos?
If you want to set up ownCloud Infinite Scale for a quick test, here's the video that shows the fastest possible way: https://cloud.owncloud.com/s/tsieyFn70U3ySm6
Basically, it's all done in three steps – assuming you already have an account for Ubernauten (Join us here: https://dashboard.uberspace.de/register?lang=en)
. Download the Infinite Scale binary and make it executable
. Set some environment variables related to Uberspace
. Start the `ocis` binary, first with the `init` parameter (which also gives you your unique login password for the user `admin`, then again with `ocis start`:
. Visit the url of your uberspace server and login:
+
image:https://cloud.owncloud.com/index.php/apps/files_sharing/ajax/publicpreview.php?x=1920&y=645&a=true&file=uberspace-login.png&t=bGkiHY25YGFtBQQ&scalingup=0[alt="Login to ownCloud Infinite Scale",width=400,height=400]
{{< toc >}}
These are the commands needed:
## Uberspace and ownCloud Infinite Scale in 50 seconds
[source,bash]
---------
This howto shows how to set up ownCloud Infinite Scale for a quick test. For convenience, we will use the free service from the Ubernauten ((Join us here: https://dashboard.uberspace.de/register?lang=en). They offer free of charge (for the first month) web hosting.
In this documentation, we are assuming you already have an account there and it is configured for SSH access. This guide is using "ocis.uber.space" as a domain at Uberspace, version 4.0.2 of Infinite Scale and the local user "owncloud". Make sure you adapt the example code and scripts mentioned in this page to your needs Both username and domain will be set when you sign in to Uberspace.
Installing ownCloud Infinite Scale on Ubernauten is pretty straigt-forward, you can do it in three steps that take less than a minute: Here's a short video that shows how fast the whole process actually is - thanks to Infinite Scale's cloud native architecture. [ownCloud Infinite Scale in 50 seconds](001-OCIS-in-50-seconds-2023-10-17.mkv)
[comment]: # Fix URL, put video in a location that makes sense. Is mkv Ok?
### Three Steps to your Infinite UberSpace
* Download the Infinite Scale binary and make it executable
```
curl https://download.owncloud.com/ocis/ocis/stable/4.0.2/ocis-4.0.2-linux-amd64 --output ocis
chmod +x ocis
```
* Set some environment variables related to Uberspace (**Make sure you fill in YOUR domain!**)
```
uberspace web backend set / --http --port 9200
export OCIS_URL=https://ocis.uber.space
export PROXY_TLS=false
export PROXY_HTTP_ADDR=0.0.0.0:9200
export PROXY_LOG_LEVEL=debug
export THUMBNAILS_WEBDAVSOURCEBASE_URL=http://localhost:9200/remote.php/webdav/
```
* Start the `ocis` binary, first with the parameter `init` for initial configuration. This will also give you your unique login password for the user `admin`. Once finished, call `ocis start`:
```
./ocis init
./ocis server
---------
```
Wait a few seconds, now you can visit the url of your uberspace server and login: ![alt="Login to ownCloud Infinite Scale"](login.png)
If you omit (or forget) the `ocis init` command, you will get the following error message:
To make it easier (and faster), here's the commands in a script called `ocis.install`:
[source,bash]
---------
[mfeilner@apus ~]$ ./ocis server
The jwt_secret has not been set properly in your config for ocis. Make sure your /home/mfeilner/.ocis/config config contains the proper values (e.g. by running ocis init or setting it manually in the config/corresponding environment variable).
The jwt_secret has not been set properly in your config for ocis. Make sure your /home/mfeilner/.ocis/config config contains the proper values (e.g. by running ocis init or setting it manually in the config/corresponding environment variable).
---------
For copy and paste, here's these commands in a script I called `ocis.start`:
[source,bash]
-----------
```
#!/bin/bash
# This file is named ocis.install
# It downloads ocis, configures the environment varialbes and starts ownCloud Infinite Scale
# It downloads ocis, configures the environment varibles and starts
# ownCloud Infinite Scale on a ubernauten account. You can run it in your home directory
curl https://download.owncloud.com/ocis/ocis/stable/4.0.2/ocis-4.0.2-linux-amd64 --output ocis
chmod +x ocis
uberspace web backend set / --http --port 9200
@@ -55,28 +61,27 @@ export OCIS_URL=https://ocis.uber.space
export PROXY_TLS=false
export PROXY_HTTP_ADDR=0.0.0.0:9200
export PROXY_LOG_LEVEL=debug
export THUMBNAILS_WEBDAVSOURCEBASE_URL=http://localhost:9200/remote.php/webdav/
./ocis init
./ocis server
-----------
Service Management with Supervisord
-----------------------------------
```
If you want ocis to run continuously, you need to configure `supervisord` (http://supervisord.org) which is the tool Uberspace is using for service management.
### Service Management with Supervisord
You can start and stop services with `supervisorctl`, it will (re)read configuration files it finds in your home directory, under `etc/services.d/`, in `.ini` files. The content of these files is very simple, you only have to enter three lines, here is the example for Infinite Scale in `/home/ocis/etc/services.d/ocis.ini`.
If you want `ocis` to run continuously, you need to configure `supervisord` (http://supervisord.org) which is the tool Uberspace is using for service management.
[source,bash]
--------
You can start and stop services with `supervisorctl`, it will (re)read configuration files it finds in your home directory, under `etc/services.d/`, in `.ini` files. The content of these files is very simple, you only have to enter three lines, here is the example for Infinite Scale in `/home/owncloud/etc/services.d/ocis.ini`.
```
{
[program:ocis]
command="/home/ocis/ocis.start"
command="/home/owncloud/ocis.start"
startsecs=60
--------
}
```
`ocis.start` is a script that combines all of the commands above except for the download of the ocis binary. It looks like this:
[source,bash]
------------
```
#!/bin/bash
# This file is named ocis.start
/usr/bin/uberspace web backend set / --http --port 9200 &
@@ -84,37 +89,35 @@ export OCIS_URL=https://ocis.uber.space
export PROXY_TLS=false
export PROXY_HTTP_ADDR=0.0.0.0:9200
export PROXY_LOG_LEVEL=debug
export THUMBNAILS_WEBDAVSOURCEBASE_URL=http://localhost:9200/remote.php/webdav/
/home/ocis/ocis server
------------
```
There are three supervisorctl commands that you will find useful (many more can be found in its documentation). You can use `supervisorctl status` to check which services managed by supervisorctl are running at the moment, a `reread` will be necessary after you changed the `ini` files, and an `update` is applying the changes:
[source,bash]
-----------
[ocis@rigel ~]$ supervisorctl status
There are three supervisorctl commands that you will find useful (many more can be found in its documentation). You can use `supervisorctl status` to check which services managed by supervisorctl are running, a `supervisorctl reread` will be necessary after you changed the `ini` files, and an `update` is applying the changes:
```
[owncloud@ocis ~]$ supervisorctl status
ocis RUNNING pid 9813, uptime 0:01:40
[ocis@rigel ~]$ supervisorctl reread
[owncloud@ocis ~]$ supervisorctl reread
No config updates to processes
[ocis@rigel ~]$ supervisorctl update
-----------
[owncloud@ocis ~]$ supervisorctl update
```
Updating ownCloud Infinite Scale
--------------------------------
### Updating ownCloud Infinite Scale
Updating the ocis binary is simple: When a new version comes to life, just download the new `ocis` binary from the download server, replacing the old `ocis` executable on your uberspace server.
Updating the ocis binary is simple: When a new version comes to life, just download the new `ocis` binary from the download server, replacing the old `ocis` executable on your uberspace server.
Make a backup of your data and make sure you have read and understood the release notes of your new version , especially the "breaking changes" section before starting the binary. Don't worry, you can always go back to the older version you had installed, there's a long list of older versions available.
Make a backup of your data and make sure you have read and understood the release notes of your new version , especially the "breaking changes" section before starting the binary.
Wiping and Clean Restart from Scratch
-------------------------------------
Don't worry, you can always go back to the older version you had installed, there's a long list of older versions available for download.
This little script is removing your ocis installation (and *all of your data*!), replacing it with a new, clean ocis installation. Be careful and only use it for testing purposes. Specify your desired ocis version in the curl command.
### Wiping and Clean Restart from Scratch
---------
[source,bash]
This little script is removing your ocis installation (and ==all of your data!==), replacing it with a new, clean ocis installation. Be careful and only use it for testing purposes. Specify your desired ocis version in the curl command.
```
{
#!/bin/bash
# This file is named ocis.reinstall
# This file is named ocis.reinstall
rm -rf .ocis
curl https://download.owncloud.com/ocis/ocis/stable/4.0.2/ocis-4.0.2-linux-amd64 --output ocis
chmod +x ocis
@@ -123,8 +126,24 @@ export OCIS_URL=https://ocis.uber.space
export PROXY_TLS=false
export PROXY_HTTP_ADDR=0.0.0.0:9200
export PROXY_LOG_LEVEL=debug
export THUMBNAILS_WEBDAVSOURCEBASE_URL=http://localhost:9200/remote.php/webdav/
./ocis init
./ocis server
---------
}
```
### Troubleshooting
* Some older versions of Infinite Scale also needed this Environment variable to run.
```
export THUMBNAILS_WEBDAVSOURCEBASE_URL=http://localhost:9200/remote.php/webdav/
```
This should not be necessary for all versions starting with ownCloud Infinite Scale 3.0.
* If you get the following error message, then you probably forgot to run the `ocis init` command. If `ocis server` find an configuration hasn't been set up, it will complain like this:
```
[owncloud@ocis ~]$ ./ocis server
The jwt_secret has not been set properly in your config for ocis.
Make sure your /home/mfeilner/.ocis/config config contains the proper values
(e.g. by running ocis init or setting it manually in the config/corresponding
environment variable).
```