Adiciona documentação de onboarding e atalhos de desenvolvimento

This commit is contained in:
Seu Nome 2025-12-30 17:19:30 -03:00
parent 7d6f00662c
commit 023b7f12fb
3 changed files with 43 additions and 0 deletions

25
Makefile Normal file
View file

@ -0,0 +1,25 @@
.PHONY: up down ps logs logs-netbox shell-netbox superuser restart-netbox
up:
docker compose up -d
down:
docker compose down
ps:
docker compose ps
logs:
docker compose logs -f --tail=200
logs-netbox:
docker compose logs -f --tail=200 netbox
shell-netbox:
docker compose exec netbox bash
superuser:
docker compose exec netbox python /opt/netbox/netbox/manage.py createsuperuser
restart-netbox:
docker compose restart netbox netbox-worker

View file

@ -13,6 +13,11 @@ and are pushed to [Docker Hub][netbox-dockerhub],
[Quay.io][netbox-quayio] and [GitHub Container Registry][netbox-ghcr].
_NetBox Docker_ is a project developed and maintained by the _NetBox_ community.
## Onboarding para desenvolvimento
Para subir o ambiente local, ver comandos Docker úteis e criar o usuário admin,
consulte o guia: [docs/onboarding.md](docs/onboarding.md).
Do you have any questions?
Before opening an issue on GitHub,
please join [our Slack][netbox-docker-slack]

13
docs/onboarding.md Normal file
View file

@ -0,0 +1,13 @@
# Onboarding - netbox-docker (Dev)
## Pré-requisitos
- Docker + Docker Compose instalados
- NetBox exposto em: **http://localhost:8001** (8001 -> 8080 no container)
## Subir o ambiente
### O que faz
Sobe Postgres + Redis/Cache + NetBox + Worker.
### Como rodar
```bash
docker compose up -d