# Netbox

**🟡 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | netbox |
| **Host** | Atlantis |
| **Category** | Other |
| **Difficulty** | 🟡 |
| **Docker Image** | `linuxserver/netbox:latest` |
| **Compose File** | `Atlantis/netbox.yml` |
| **Directory** | `Atlantis` |

## 🎯 Purpose

netbox 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 (Atlantis)

### Deployment
```bash
# Navigate to service directory
cd Atlantis

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f netbox
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: NETBOX
depends_on:
  netbox-db:
    condition: service_healthy
  netbox-redis:
    condition: service_healthy
environment:
- PUID=1026
- PGID=100
- TZ=America/Los_Angeles
- SUPERUSER_EMAIL=your-email@example.com
- SUPERUSER_PASSWORD="REDACTED_PASSWORD"
- ALLOWED_HOST=10.0.0.100
- DB_HOST=netbox-db
- DB_PORT=5432
- DB_NAME=netbox
- DB_USER=netbox-user
- DB_PASSWORD="REDACTED_PASSWORD"
- REDIS_HOST=netbox-redis
- REDIS_PORT=6379
- REDIS_PASSWORD="REDACTED_PASSWORD"
- REDIS_DB_TASK=0
- REDIS_DB_CACHE=1
healthcheck:
  test: wget --no-verbose --tries=1 --spider http://10.0.0.100:9458/ || exit 1
hostname: netbox
image: linuxserver/netbox:latest
ports:
- 10.0.0.100:9458:8000
restart: always
volumes:
- /volume1/docker/netbox/config:/config

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `PUID` | `1026` | User ID for file permissions |
| `PGID` | `100` | Group ID for file permissions |
| `TZ` | `America/Los_Angeles` | Timezone setting |
| `SUPERUSER_EMAIL` | `your-email@example.com` | Configuration variable |
| `SUPERUSER_PASSWORD` | `***MASKED***` | Configuration variable |
| `ALLOWED_HOST` | `10.0.0.100` | Configuration variable |
| `DB_HOST` | `netbox-db` | Configuration variable |
| `DB_PORT` | `5432` | Configuration variable |
| `DB_NAME` | `netbox` | Configuration variable |
| `DB_USER` | `netbox-user` | Configuration variable |
| `DB_PASSWORD` | `***MASKED***` | Configuration variable |
| `REDIS_HOST` | `netbox-redis` | Configuration variable |
| `REDIS_PORT` | `6379` | Configuration variable |
| `REDIS_PASSWORD` | `***MASKED***` | Redis authentication password |
| `REDIS_DB_TASK` | `0` | Configuration variable |
| `REDIS_DB_CACHE` | `1` | Configuration variable |


### Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|-----------|----------------|----------|----------|
| 10.0.0.100 | 9458:8000 | TCP | Service port |


### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/volume1/docker/netbox/config` | `/config` | bind | Configuration files |


## 🌐 Access Information

Service ports: 10.0.0.100:9458:8000

## 🔒 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

✅ Health check configured
**Test Command**: `wget --no-verbose --tries=1 --spider http://10.0.0.100:9458/ || exit 1`

### 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 netbox

# Restart service
docker-compose restart netbox

# Update service
docker-compose pull netbox
docker-compose up -d netbox

# Access service shell
docker-compose exec netbox /bin/bash
# or
docker-compose exec netbox /bin/sh
```

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for netbox
- **Docker Hub**: [linuxserver/netbox:latest](https://hub.docker.com/r/linuxserver/netbox: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 Atlantis

---

*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**: `Atlantis/netbox.yml`