Files
QSfera/Server/deployments/examples/bare-metal-simple/README.md
T
Курнат Андрей 2315f25754 Initial QSfera import
2026-06-07 10:20:04 +03:00

80 lines
2.2 KiB
Markdown

# Simple Bare Metal Install
This install script downloads and installs the КуСфера binary and
configures it in a sandbox directory in the folder where you called
the install script. It also adds a start script called `runqsfera.sh`
to start КуСфера later.
The installation only consists of the bare minimum functionality
without web office and other optional components. Also, it is bound
to localhost by default. **It is only useful for simple test- and
demo cases and not for production.**
To use КуСфера, start it with the start script and head your
browser to http://localhost:9200.
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.
## Data Location
Set the environment variable `OC_BASE_DIR` to a directory where the
`data` and `config` subdirectories shall be located. Per default,
both configuration and storage data are within a sandbox subdirectory
in the current working directory.
## Server Address
Set the environment variable `OC_HOST` to the fully qualified hostname
of this server to allow remote access. Default: `localhost`.
## HTTPS
The demo setup uses plain HTTP by default so browsers can open it
without a certificate warning. If HTTPS is required, set `OC_TLS=true`
before running the install script:
```
OC_TLS=true ./install.sh
```
In HTTPS mode the proxy creates a self-signed certificate unless
`PROXY_TRANSPORT_TLS_CERT` and `PROXY_TRANSPORT_TLS_KEY` point to a
certificate trusted by the browser. A self-signed certificate is useful
for tests, but Chrome will show `ERR_CERT_AUTHORITY_INVALID` for it.
For an existing demo install that should be reachable on a LAN address
without a browser certificate warning, edit `runqsfera.sh` so the public
URL and proxy TLS settings match the address:
```
export OC_URL=http://192.168.0.185:9200
export PROXY_TLS=false
```
# Example
Call
```
OC_VERSION="2.0.0" ./install.sh
```
to install the КуСфера version 2.0.0
There is also a hosted version of this script that makes it even
easier:
```
curl -L https://qsfera.eu/install.sh | bash -x
```