From 023b7f12fba7b9893cd08a7b53ffbf04fc397f51 Mon Sep 17 00:00:00 2001 From: Seu Nome Date: Tue, 30 Dec 2025 17:19:30 -0300 Subject: [PATCH 1/2] =?UTF-8?q?Adiciona=20documenta=C3=A7=C3=A3o=20de=20on?= =?UTF-8?q?boarding=20e=20atalhos=20de=20desenvolvimento?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 25 +++++++++++++++++++++++++ README.md | 5 +++++ docs/onboarding.md | 13 +++++++++++++ 3 files changed, 43 insertions(+) create mode 100644 Makefile create mode 100644 docs/onboarding.md diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..250a890 --- /dev/null +++ b/Makefile @@ -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 diff --git a/README.md b/README.md index 74b1ad7..cb9df31 100644 --- a/README.md +++ b/README.md @@ -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] diff --git a/docs/onboarding.md b/docs/onboarding.md new file mode 100644 index 0000000..54e8339 --- /dev/null +++ b/docs/onboarding.md @@ -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 From 36d4c39484f8069d868b1ab8d484a6c8c01c8a33 Mon Sep 17 00:00:00 2001 From: Seu Nome Date: Wed, 31 Dec 2025 14:21:06 -0300 Subject: [PATCH 2/2] =?UTF-8?q?Melhora=20documenta=C3=A7=C3=A3o=20de=20onb?= =?UTF-8?q?oarding=20de=20dev?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/onboarding.md | 54 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 50 insertions(+), 4 deletions(-) diff --git a/docs/onboarding.md b/docs/onboarding.md index 54e8339..55a6ae4 100644 --- a/docs/onboarding.md +++ b/docs/onboarding.md @@ -1,13 +1,59 @@ # Onboarding - netbox-docker (Dev) +## Visão geral +Este repositório sobe o NetBox em ambiente de desenvolvimento usando Docker Compose. + +**Acesso local:** http://localhost:8001 +(Porta `8001` no host → `8080` dentro do container `netbox`) + +Serviços principais: +- `postgres` (banco) +- `redis` e `redis-cache` (cache/filas) +- `netbox` (web) +- `netbox-worker` (tarefas assíncronas) + +--- + ## Pré-requisitos -- Docker + Docker Compose instalados -- NetBox exposto em: **http://localhost:8001** (8001 -> 8080 no container) +- Docker + Docker Compose (comando `docker compose`) +- `curl` instalado +- Porta `8001` livre no host +- (Opcional) `make` para usar os atalhos do `Makefile` + +--- + +## Arquivos importantes do projeto +- `docker-compose.yml` + Define os serviços, volumes, healthchecks e dependências. +- `docker-compose.override.yml` + Ajustes locais (ex.: mapeamento `8001:8080`). +- `env/*.env` + Variáveis de ambiente por serviço (dev). + **Boas práticas:** não reutilizar esses valores em produção; em produção use secrets/variáveis seguras. +- `Makefile` + Atalhos para os comandos mais usados. + +Atalhos disponíveis no Makefile: +- `make up` / `make down` / `make ps` +- `make logs` / `make logs-netbox` +- `make shell-netbox` +- `make superuser` +- `make restart-netbox` +- `make db-shell` +- `make manage cmd=...` + +--- ## Subir o ambiente + ### O que faz -Sobe Postgres + Redis/Cache + NetBox + Worker. +Sobe Postgres + Redis + Redis-cache + NetBox + Worker em background. + +### Quando usar +Primeira vez no dia, após reiniciar a máquina, ou depois de derrubar o ambiente. ### Como rodar ```bash -docker compose up -d +make up +# ou: dockerup +# ou: docker compose up -d