Add the bare metal simple install script as example

2025-03-05 11:32:31 +01:00
parent 9c85f9e02f
commit 11fe6bb9f4
2 changed files with 153 additions and 0 deletions
@@ -0,0 +1,44 @@
+# Simple Bare Metal Install
+
+This install script downloads and installs the OpenCloud binary and
+configures it in a sandbox directory in the folder where you called
+the install script. It also adds a start script called `runopencloud.sh`
+to start OpenCloud later.
+
+The installation only consists of the bare minimum functionality 
+without web office and other optional components. Also, it is bound
+to localhost and has no valid certificates. ** It is only
+useful for simple test- and demo cases and not for production.**
+
+To use OpenCloud, start it with the start script and head your
+browser to https://localhost:9200. The invalid certificate  must
+be acknowledged in the browser.
+
+The demo users (eg. alan / demo) are enabled, the admin password
+is surprisingly `admin`.
+
+This script should **NOT** be run as user root.
+
+# Options
+
+## Version
+
+Set the environment variable `OC_VERSION` to the version you want
+to download. If not set, there is a reasonable default. 
+
+# Example
+
+Call
+
+```
+OC_VERSION="1.0.0" ./install.sh
+``` 
+to install the OpenCloud version 1.0.0
+
+There is also a hosted version of this script that makes it even
+easier:
+
+```
+curl -L https://opencloud.eu/oc-install.sh | bash -x 
+```
+