#84 Improve descriptions and keep things short

This commit is contained in:
Daniel Brendel
2024-01-22 12:36:54 +01:00
parent 753765aa2c
commit be32446219
3 changed files with 13 additions and 14 deletions
+12 -12
View File
@@ -45,7 +45,7 @@ users have taken. The system features collaborative management, so you can manag
- [Official Homepage](https://www.hortusfox.com/)
- [Documentation](https://hortusfox.github.io/)
## Installation
## Table of Contents
- [Description](#description)
- [Features](#features)
@@ -84,14 +84,14 @@ Set these in your docker-compose.yml file:
| Variable | Description | Example | Required |
| ------------------------------ | ------------------------------------------------------ | -------------------- | :------: |
| APP_ADMIN_EMAIL | Administrator email, will be autogenerated if blank | "admin@admin.com" | No |
| APP_ADMIN_EMAIL | Administrator email for logging in | "admin@admin.com" | No |
| APP_ADMIN_PASSWORD | Administrator password, will be autogenerated if blank | "mypasswordhere" | No |
| APP_BASE_DIR | | "" | Yes |
| APP_DEBUG | Enable debug mode | false | Yes |
| APP_LANG | language | "en" | Yes |
| APP_WORKSPACE | Title | "My plant home" | Yes |
| APP_ENABLE_SCROLLER | | "true" | Yes |
| APP_OVERLAY_ALPHA | | "null" | Yes |
| APP_LANG | Base language of the app interface | "en" | Yes |
| APP_WORKSPACE | Your workspace name | "My plant home" | Yes |
| APP_ENABLE_SCROLLER | Shows a back-to-top scroller on the bottom right | "true" | Yes |
| APP_OVERLAY_ALPHA | In case you are using a custom bg image | "null" | Yes |
| APP_ENABLE_CHAT | Enable chat in application | "true" | Yes |
| APP_ONLINE_MINUTE_LIMIT | Delay before showing offline | 5 | Yes |
| APP_SHOW_CHAT_ONLINE_USERS | Show online users in chat | "false" | Yes |
@@ -113,14 +113,14 @@ Set these in your docker-compose.yml file:
| DB_USERNAME | Database user | root | Yes |
| DB_PASSWORD | Database password | my-secret-pw | Yes |
| DB_CHARSET | Database character set | utf8mb4 | Yes |
| SMTP_FROMNAME | Email from name | John Smith | Yes |
| SMTP_FROMADDRESS | Email from address | john.smith@aol.com | Yes |
| SMTP_FROMNAME | Email from name | Service | Yes |
| SMTP_FROMADDRESS | Email from address | service@workspace.tld| Yes |
| SMTP_HOST | Email server hostname | mail.aol.com | Yes |
| SMTP_PORT | Email server port number | 587 | Yes |
| SMTP_USERNAME | Email server username | jsmith | Yes |
| SMTP_PASSWORD | Email server pasword | myPasswordHere | Yes |
| SMTP_PORT | Email server port | 587 | Yes |
| SMTP_USERNAME | Email server username | username | Yes |
| SMTP_PASSWORD | Email server pasword | password | Yes |
| SMTP_ENCRYPTION | Email server encryption | tls | Yes |
| LOG_ENABLE | Enable log collection | true | Yes |
| LOG_ENABLE | Enable application logging | true | Yes |
3. Pull the image and run the application:
+1 -1
View File
@@ -10,7 +10,7 @@ services:
- app_logs:/var/www/html/app/logs
environment:
APP_ADMIN_EMAIL: "admin@admin.com"
APP_ADMIN_PASSWORD: "mypasswordhere"
APP_ADMIN_PASSWORD: "password"
APP_BASE_DIR: ""
APP_DEBUG: "true"
APP_LANG: "en"
-1
View File
@@ -23,7 +23,6 @@ configure_php_error_reporting() {
# Function to create the .env file
create_environment_file() {
# Remove if already exists
rm -f "/var/www/html/.env"
cat <<-EOF >> /var/www/html/.env