Update CloudronManifest.json and documentation files

This commit is contained in:
Andreas Düren
2025-03-16 18:18:16 +01:00
parent 3743e382b7
commit cc6a8d193a
5 changed files with 167 additions and 322 deletions

View File

@@ -4,10 +4,11 @@ This package provides Elasticsearch for Cloudron, configured for internal use on
## Features
- Elasticsearch 8.17.3 (configurable)
- Elasticsearch 8.17.3
- Single-node configuration optimized for Cloudron
- Security enabled with basic authentication
- Internal access only
- Automatic optimization based on container resources
## Usage
@@ -18,39 +19,53 @@ After installation, Elasticsearch will be available at the following URLs:
### Authentication
Default credentials:
Authentication credentials:
- Username: `elastic`
- Password: `cloudron`
- Password: A secure random password is generated during installation
It's recommended to change the default password after installation by updating the `.env` file and restarting the app.
You can find the password in:
1. The app logs after installation
2. By accessing the app container
3. The file at `/app/data/credentials.txt`
### Connection from other Cloudron apps
To connect to Elasticsearch from another Cloudron app, you can use the following connection details:
To connect to Elasticsearch from another Cloudron app, use the following connection details:
```
Host: localhost
Port: 9200
Protocol: http
Username: elastic
Password: <your password from .env>
Password: <password from credentials.txt>
```
## Configuration
Example connection using cURL:
You can modify the configuration by editing the `.env` file in the app's data directory and restarting the app.
```bash
curl -u elastic:<password> http://localhost:9200
```
Available configuration options:
## Security Notes
- `ELASTIC_PASSWORD`: Password for the 'elastic' user
- `STACK_VERSION`: Version of Elasticsearch to use
- `CLUSTER_NAME`: Name of the Elasticsearch cluster
- `LICENSE`: License type ('basic' or 'trial')
- HTTP SSL is disabled for compatibility with most client applications
- Transport protocol is secured with internal certificates
- Authentication is required for all operations
- All data is stored in the app's data directory
## Performance Configuration
The package automatically configures Elasticsearch based on the container's available resources:
- Java heap size is set to 50% of available memory
- GC optimization for container environments
- Index settings tuned for single-node operation
## Limitations
- This package is for internal use only and is not exposed to the web
- It's configured as a single-node cluster for simplicity
- Memory is limited to 1GB (configurable in CloudronManifest.json)
- Memory usage scales with container limits set in Cloudron
## Support