204 lines
5.2 KiB
Markdown
204 lines
5.2 KiB
Markdown
# Neko Rooms
|
|
|
|
**🟢 Other Service**
|
|
|
|
## 📋 Service Overview
|
|
|
|
| Property | Value |
|
|
|----------|-------|
|
|
| **Service Name** | neko-rooms |
|
|
| **Host** | Chicago_vm |
|
|
| **Category** | Other |
|
|
| **Difficulty** | 🟢 |
|
|
| **Docker Image** | `m1k1o/neko-rooms:latest` |
|
|
| **Compose File** | `Chicago_vm/neko.yml` |
|
|
| **Directory** | `Chicago_vm` |
|
|
|
|
## 🎯 Purpose
|
|
|
|
neko-rooms is a specialized service that provides specific functionality for the homelab infrastructure.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Prerequisites
|
|
- Docker and Docker Compose installed
|
|
- Basic understanding of REDACTED_APP_PASSWORD
|
|
- Access to the host system (Chicago_vm)
|
|
|
|
### Deployment
|
|
```bash
|
|
# Navigate to service directory
|
|
cd Chicago_vm
|
|
|
|
# Start the service
|
|
docker-compose up -d
|
|
|
|
# Check service status
|
|
docker-compose ps
|
|
|
|
# View logs
|
|
docker-compose logs -f neko-rooms
|
|
```
|
|
|
|
## 🔧 Configuration
|
|
|
|
### Docker Compose Configuration
|
|
```yaml
|
|
environment:
|
|
- TZ=America/Los_Angeles
|
|
- NEKO_ROOMS_MUX=true
|
|
- NEKO_ROOMS_EPR=59000-59049
|
|
- NEKO_ROOMS_NAT1TO1=74.91.118.242
|
|
- NEKO_ROOMS_INSTANCE_URL=https://showtime.vish.gg/
|
|
- NEKO_ROOMS_STORAGE_ENABLED=true
|
|
- NEKO_ROOMS_STORAGE_INTERNAL=/data
|
|
- NEKO_ROOMS_STORAGE_EXTERNAL=/opt/neko-rooms/data
|
|
- NEKO_ROOMS_INSTANCE_NETWORK=neko-rooms-net
|
|
- NEKO_ROOMS_TRAEFIK_ENABLED=false
|
|
- NEKO_ROOMS_PATH_PREFIX=/room/
|
|
image: m1k1o/neko-rooms:latest
|
|
ports:
|
|
- 8080:8080
|
|
restart: unless-stopped
|
|
volumes:
|
|
- /var/run/docker.sock:/var/run/docker.sock
|
|
- /opt/neko-rooms/data:/data
|
|
|
|
```
|
|
|
|
### Environment Variables
|
|
| Variable | Value | Description |
|
|
|----------|-------|-------------|
|
|
| `TZ` | `America/Los_Angeles` | Timezone setting |
|
|
| `NEKO_ROOMS_MUX` | `true` | Configuration variable |
|
|
| `NEKO_ROOMS_EPR` | `59000-59049` | Configuration variable |
|
|
| `NEKO_ROOMS_NAT1TO1` | `74.91.118.242` | Configuration variable |
|
|
| `NEKO_ROOMS_INSTANCE_URL` | `https://showtime.vish.gg/` | Configuration variable |
|
|
| `NEKO_ROOMS_STORAGE_ENABLED` | `true` | Configuration variable |
|
|
| `NEKO_ROOMS_STORAGE_INTERNAL` | `/data` | Configuration variable |
|
|
| `NEKO_ROOMS_STORAGE_EXTERNAL` | `/opt/neko-rooms/data` | Configuration variable |
|
|
| `NEKO_ROOMS_INSTANCE_NETWORK` | `neko-rooms-net` | Configuration variable |
|
|
| `NEKO_ROOMS_TRAEFIK_ENABLED` | `false` | Configuration variable |
|
|
| `NEKO_ROOMS_PATH_PREFIX` | `/room/` | Configuration variable |
|
|
|
|
|
|
### Port Mappings
|
|
| Host Port | Container Port | Protocol | Purpose |
|
|
|-----------|----------------|----------|----------|
|
|
| 8080 | 8080 | TCP | Alternative HTTP port |
|
|
|
|
|
|
### Volume Mappings
|
|
| Host Path | Container Path | Type | Purpose |
|
|
|-----------|----------------|------|----------|
|
|
| `/var/run/docker.sock` | `/var/run/docker.sock` | bind | Data storage |
|
|
| `/opt/neko-rooms/data` | `/data` | bind | Application data |
|
|
|
|
|
|
## 🌐 Access Information
|
|
|
|
### Web Interface
|
|
- **HTTP**: `http://Chicago_vm:8080`
|
|
|
|
### Default Credentials
|
|
Refer to service documentation for default credentials
|
|
|
|
## 🔒 Security Considerations
|
|
|
|
- ⚠️ Consider adding security options (no-new-privileges)
|
|
- ⚠️ Consider running as non-root user
|
|
|
|
## 📊 Resource Requirements
|
|
|
|
No resource limits configured
|
|
|
|
### Recommended Resources
|
|
- **Minimum RAM**: 512MB
|
|
- **Recommended RAM**: 1GB+
|
|
- **CPU**: 1 core minimum
|
|
- **Storage**: Varies by usage
|
|
|
|
### Resource Monitoring
|
|
Monitor resource usage with:
|
|
```bash
|
|
docker stats
|
|
```
|
|
|
|
## 🔍 Health Monitoring
|
|
|
|
⚠️ No health check configured
|
|
Consider adding a health check:
|
|
```yaml
|
|
healthcheck:
|
|
test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
|
|
interval: 30s
|
|
timeout: 10s
|
|
retries: 3
|
|
```
|
|
|
|
### Manual Health Checks
|
|
```bash
|
|
# Check container health
|
|
docker inspect --format='{{.State.Health.Status}}' CONTAINER_NAME
|
|
|
|
# View health check logs
|
|
docker inspect --format='{{range .State.Health.Log}}{{.Output}}{{end}}' CONTAINER_NAME
|
|
```
|
|
|
|
## 🚨 Troubleshooting
|
|
|
|
### Common Issues
|
|
**Service won't start**
|
|
- Check Docker logs: `docker-compose logs service-name`
|
|
- Verify port availability: `netstat -tulpn | grep PORT`
|
|
- Check file permissions on mounted volumes
|
|
|
|
**Can't access web interface**
|
|
- Verify service is running: `docker-compose ps`
|
|
- Check firewall settings
|
|
- Confirm correct port mapping
|
|
|
|
**Performance issues**
|
|
- Monitor resource usage: `docker stats`
|
|
- Check available disk space: `df -h`
|
|
- Review service logs for errors
|
|
|
|
### Useful Commands
|
|
```bash
|
|
# Check service status
|
|
docker-compose ps
|
|
|
|
# View real-time logs
|
|
docker-compose logs -f neko-rooms
|
|
|
|
# Restart service
|
|
docker-compose restart neko-rooms
|
|
|
|
# Update service
|
|
docker-compose pull neko-rooms
|
|
docker-compose up -d neko-rooms
|
|
|
|
# Access service shell
|
|
docker-compose exec neko-rooms /bin/bash
|
|
# or
|
|
docker-compose exec neko-rooms /bin/sh
|
|
```
|
|
|
|
## 📚 Additional Resources
|
|
|
|
- **Official Documentation**: Check the official docs for neko-rooms
|
|
- **Docker Hub**: [m1k1o/neko-rooms:latest](https://hub.docker.com/r/m1k1o/neko-rooms:latest)
|
|
- **Community Forums**: Search for community discussions and solutions
|
|
- **GitHub Issues**: Check the project's GitHub for known issues
|
|
|
|
## 🔗 Related Services
|
|
|
|
Other services in the other category on Chicago_vm
|
|
|
|
---
|
|
|
|
*This documentation is auto-generated from the Docker Compose configuration. For the most up-to-date information, refer to the official documentation and the actual compose file.*
|
|
|
|
**Last Updated**: 2025-11-17
|
|
**Configuration Source**: `Chicago_vm/neko.yml`
|