add instructions

This commit is contained in:
2024-12-23 01:09:01 +01:00
parent 6f51092f0f
commit 7e01e713b7

39
README.md Normal file
View File

@ -0,0 +1,39 @@
# Installation Script for OpenEMS
This installation script automates the setup of OpenEMS on a server. It performs the following tasks:
1. **Host Configuration**: Prompts the user to enter the host name for the server. If no input is provided, it defaults to the current hostname.
2. **UI Default Setting**: Asks the user if they want to set the OpenEMS UI as the default for the server. If confirmed, it warns that this will override the default Nginx configuration.
3. **Package Installation**: Updates the package list and installs the required packages, including OpenJDK 17, Nginx, and Wget.
4. **OpenEMS Service Setup**: Downloads the OpenEMS system service configuration and sets up the necessary directories and files for OpenEMS.
5. **Nginx Configuration**: Sets up the Nginx server to serve the OpenEMS UI, including downloading the UI files and configuring the Nginx site.
6. **Service Management**: Reloads the systemd manager configuration, enables, and starts the OpenEMS service, and restarts Nginx to apply the new configuration.
### Installation Instructions
You can install OpenEMS by following these steps:
1. Download the installation script:
```bash
curl -O https://git.mumme-it.de/Mumme-IT/openems-build/src/branch/main/installation/install-openems.sh
```
2. Review the script contents (recommended for security):
```bash
less install-openems.sh
```
3. Make the script executable:
```bash
chmod +x install-openems.sh
```
4. Run the script with sudo:
```bash
sudo ./install-openems.sh
```