Initial OpenObserve Cloudron package

BUILD.md

@@ -0,0 +1,153 @@
+# OpenObserve Cloudron Package Build Instructions
+
+## Prerequisites
+
+1. Cloudron CLI installed and configured
+2. Docker access (for build service)
+3. Access to the Cloudron build service at builder.docker.due.ren
+
+## Build Process
+
+### 1. Build the Package
+
+Use the Cloudron build service to create the Docker image:
+
+```bash
+cloudron build \
+  --set-build-service builder.docker.due.ren \
+  --build-service-token e3265de06b1d0e7bb38400539012a8433a74c2c96a17955e \
+  --set-repository andreasdueren/openobserve-cloudron \
+  --tag 0.1.0
+```
+
+### 2. Install the Application
+
+Install the built image to your Cloudron instance:
+
+```bash
+cloudron install \
+  --location openobserve.due.ren \
+  --image andreasdueren/openobserve-cloudron:0.1.0
+```
+
+**Important**: Wait no more than 30 seconds for installation feedback. If there are errors, the installation may hang indefinitely.
+
+### 3. Development Workflow
+
+For development and testing:
+
+1. **Always uninstall before reinstalling** (never update during development):
+   ```bash
+   cloudron uninstall --app openobserve.due.ren
+   ```
+
+2. Make your changes to the package files
+
+3. Rebuild and reinstall:
+   ```bash
+   # Build
+   cloudron build --set-build-service builder.docker.due.ren --build-service-token e3265de06b1d0e7bb38400539012a8433a74c2c96a17955e --set-repository andreasdueren/openobserve-cloudron --tag 0.1.0
+   
+   # Install
+   cloudron install --location openobserve.due.ren --image andreasdueren/openobserve-cloudron:0.1.0
+   ```
+
+## Verification
+
+### 1. Check Application Status
+
+```bash
+cloudron status --app openobserve.due.ren
+```
+
+### 2. View Logs
+
+```bash
+# Follow logs
+cloudron logs --app openobserve.due.ren -f
+
+# View specific logs
+cloudron exec --app openobserve.due.ren
+# tail -f /var/log/nginx/error.log
+```
+
+### 3. Access the Application
+
+1. Navigate to your configured domain (e.g., https://openobserve.due.ren)
+2. Login with default credentials:
+   - Email: admin@openobserve.due.ren
+   - Password: openobserve123
+3. **Immediately change the default password**
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Build Failures**
+   - Check Docker image availability
+   - Verify binary download URLs
+   - Ensure proper file permissions
+
+2. **Installation Hangs**
+   - Cancel after 30 seconds
+   - Check build service status
+   - Review application logs
+
+3. **Authentication Issues**
+   - Verify OIDC configuration in start.sh
+   - Check Cloudron OIDC environment variables
+   - Review nginx proxy settings
+
+### Debugging Commands
+
+```bash
+# Shell into the application
+cloudron exec --app openobserve.due.ren
+
+# Check process status
+ps aux | grep openobserve
+
+# Check nginx status
+systemctl status nginx
+
+# View configuration
+cat /app/data/config.yaml
+```
+
+## Package Structure
+
+```
+openobserve-cloudron/
+├── CloudronManifest.json   # Package configuration
+├── Dockerfile             # Container build instructions
+├── start.sh              # Application startup script
+├── nginx.conf            # Reverse proxy configuration
+├── logo.png              # Application icon
+├── POSTINSTALL           # Post-installation message
+├── CHANGELOG             # Version history
+└── BUILD.md              # This file
+```
+
+## Configuration
+
+### Environment Variables
+
+The application uses these key environment variables:
+
+- `ZO_ROOT_USER_EMAIL` - Default admin email
+- `ZO_ROOT_USER_PASSWORD` - Default admin password
+- `CLOUDRON_OIDC_*` - OIDC authentication settings
+- `CLOUDRON_MAIL_SMTP_*` - Email configuration
+
+### Data Persistence
+
+- Application data: `/app/data`
+- Logs: `/app/data/logs`
+- Database: `/app/data/db`
+- WAL files: `/app/data/wal`
+
+## Support
+
+- OpenObserve Documentation: https://openobserve.ai/docs/
+- Cloudron Packaging: https://docs.cloudron.io/packaging/
+- GitHub Repository: https://github.com/openobserve/openobserve