Commit f9b63f
2025-07-27 21:29:54 mvbingham: added CheckCie| /dev/null .. docker compose files/checkcie.md | |
| @@ 0,0 1,89 @@ | |
| + | # CheckCie |
| + | |
| + | CheckCie is a web-based application that provides an interface for managing and monitoring your systems. It's designed to be lightweight and easy to deploy using Docker. |
| + | |
| + | ## Features |
| + | |
| + | - Web-based interface accessible on port 8090 |
| + | - Persistent data storage through volume mapping |
| + | - Automatic restart capability |
| + | - Optimized file handle limits for better performance |
| + | |
| + | ## Docker Compose Configuration |
| + | |
| + | ```yaml |
| + | services: |
| + | checkcle: |
| + | image: operacle/checkcle:latest |
| + | container_name: checkcle |
| + | restart: unless-stopped |
| + | ports: |
| + | - "8090:8090" # Web Application |
| + | volumes: |
| + | - /opt/pb_data:/mnt/pb_data # Host directory mapped to container path |
| + | ulimits: |
| + | nofile: |
| + | soft: 4096 |
| + | hard: 8192 |
| + | ``` |
| + | |
| + | ## Usage |
| + | |
| + | 1. Save this configuration in a `docker-compose.yml` file |
| + | 2. Deploy the container by running: |
| + | |
| + | ```bash |
| + | docker compose up -d |
| + | ``` |
| + | |
| + | 3. Access the web interface at `http://your-server-ip:8090` |
| + | |
| + | ## Portainer Installation |
| + | |
| + | To deploy this container using Portainer: |
| + | |
| + | 1. Log into your Portainer instance |
| + | 2. Navigate to your desired environment |
| + | 3. Click on "Stacks" in the left sidebar |
| + | 4. Click the "+ Add stack" button |
| + | 5. Enter a name for your stack (e.g., "checkcie") |
| + | 6. In the "Web editor" tab, copy and paste the following configuration: |
| + | |
| + | ```yaml |
| + | services: |
| + | checkcle: |
| + | image: operacle/checkcle:latest |
| + | container_name: checkcle |
| + | restart: unless-stopped |
| + | ports: |
| + | - "8090:8090" # Web Application |
| + | volumes: |
| + | - /opt/pb_data:/mnt/pb_data # Host directory mapped to container path |
| + | ulimits: |
| + | nofile: |
| + | soft: 4096 |
| + | hard: 8192 |
| + | ``` |
| + | |
| + | 7. Click "Deploy the stack" |
| + | 8. Once deployed, access CheckCie at `http://your-server-ip:8090` |
| + | |
| + | ## Volume Configuration |
| + | |
| + | The container uses a volume mount at `/opt/pb_data` to persist data. Make sure this directory exists on your host system and has appropriate permissions. |
| + | |
| + | ## System Requirements |
| + | |
| + | - Docker Engine 20.10 or later |
| + | - At least 1GB of RAM |
| + | - Sufficient disk space for data storage (recommended: 10GB+) |
| + | |
| + | ## Maintenance |
| + | |
| + | - Logs can be viewed using: `docker logs checkcle` |
| + | - Updates can be applied by pulling the latest image and restarting the container: |
| + | |
| + | ```bash |
| + | docker compose pull |
| + | docker compose up -d |
| + | ``` |