98 lines
1.6 KiB
Markdown
98 lines
1.6 KiB
Markdown
# Docker Quick Start Guide
|
|
|
|
Get ZynkTime running in 3 simple steps!
|
|
|
|
## Prerequisites
|
|
|
|
- Docker installed ([Get Docker](https://docs.docker.com/get-docker/))
|
|
- Docker Compose installed (included with Docker Desktop)
|
|
|
|
## Step 1: Configure
|
|
|
|
```bash
|
|
# Copy environment template
|
|
cp .env.example .env
|
|
|
|
# Edit with your API key
|
|
nano .env
|
|
```
|
|
|
|
Add your API key:
|
|
```env
|
|
KLEER_API_KEY=your_actual_api_key_here
|
|
KLEER_USERNAME=Your Name
|
|
KLEER_COMPANY_ID=1336
|
|
```
|
|
|
|
## Step 2: Start
|
|
|
|
```bash
|
|
# Build and start the application
|
|
docker-compose up -d
|
|
```
|
|
|
|
This will:
|
|
- Build the Docker image
|
|
- Start the container
|
|
- Expose the application on port 8000
|
|
|
|
## Step 3: Use
|
|
|
|
Open your browser:
|
|
```
|
|
http://localhost:8000
|
|
```
|
|
|
|
You should see the beautiful ZynkTime web interface!
|
|
|
|
## Common Commands
|
|
|
|
```bash
|
|
# View logs
|
|
docker-compose logs -f
|
|
|
|
# Stop application
|
|
docker-compose down
|
|
|
|
# Restart after changes
|
|
docker-compose restart
|
|
|
|
# Rebuild after code changes
|
|
docker-compose up -d --build
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
**Container won't start?**
|
|
```bash
|
|
docker-compose logs zynktime
|
|
```
|
|
|
|
**API key not working?**
|
|
```bash
|
|
# Check environment variables
|
|
docker-compose exec zynktime env | grep KLEER
|
|
```
|
|
|
|
**Port already in use?**
|
|
Edit `docker-compose.yml` and change the port:
|
|
```yaml
|
|
ports:
|
|
- "8080:8000" # Change 8080 to any free port
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
- See [DOCKER.md](DOCKER.md) for advanced configuration
|
|
- See [README.md](README.md) for full documentation
|
|
- See [UI_FEATURES.md](UI_FEATURES.md) for UI details
|
|
|
|
## Support
|
|
|
|
For issues, check the logs first:
|
|
```bash
|
|
docker-compose logs -f zynktime
|
|
```
|
|
|
|
Happy time reporting! 🎉
|