-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
317 lines (317 loc) · 17.6 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
site_name: Documentação Netbox
site_dir: ./site
site_url: https://docs.netbox.dev.br/
docs_dir: ./docs
repo_name: netbox-community/netbox
repo_url: https://github.com/netbox-community/netbox
theme:
name: material
custom_dir: docs/_theme/
icon:
repo: fontawesome/brands/github
language: pt-BR
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/lightbulb-outline
name: Switch to Dark Mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/lightbulb
name: Switch to Light Mode
features:
- navigation.instant
- navigation.tracking
- search.suggest
- search.highlight
- navigation.footer
- navigation.path
- navigation.top
- toc.follow
- toc.integrate
plugins:
- search
- social
#- mkdocstrings:
# handlers:
# python:
# setup_commands:
# - import os
# - import django
# - os.chdir('netbox/')
# - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
# - django.setup()
# options:
# heading_level: 3
# members_order: source
# show_root_heading: true
# show_root_full_path: false
# show_root_toc_entry: false
# show_source: false
extra:
google_analytics:
tracking_id: UA-227228706-1
measurement_id: G-R708SEN30V
social:
- icon: fontawesome/brands/github
link: https://github.com/netbox-community/netbox
- icon: fontawesome/brands/slack
link: https://netdev.chat/
- icon: fontawesome/brands/telegram
link: https://t.me/netboxbr
- icon: fontawesome/brands/discord
link: https://discord.gg/9N3V4mpMXU
homepage: https://netboxlabs.com
extra_css:
- https://cdn.materialdesignicons.com/5.4.55/css/materialdesignicons.min.css
- extra.css
markdown_extensions:
- attr_list
- def_list
- md_in_html
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- admonition
- abbr
- toc:
permalink: true
toc_depth: 4
- tables
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
extra_javascript:
- 'https://cdn.jsdelivr.net/npm/@material-icons/iconfont/material-icons.min.js'
nav:
- Introdução: 'introduction.md'
- Características e Funções:
- Instalações (Facilities): 'features/facilities.md'
- Dispositivos & Cabeamento (em Inglês ainda): 'features/devices-cabling.md'
- Mapeamento de Energia (em Inglês ainda): 'features/power-tracking.md'
- IPAM (Endereçamento IP) - em Inglês ainda: 'features/ipam.md'
- Gerência de VLANs (em Inglês ainda): 'features/vlan-management.md'
- L2VPN & Overlay (em Inglês ainda): 'features/l2vpn-overlay.md'
- Circuitos (em Inglês ainda): 'features/circuits.md'
- Wireless (Wi-Fi) - em Inglês ainda: 'features/wireless.md'
- Virtualização (em Inglês ainda): 'features/virtualization.md'
- Locação (Tenancy) - em Inglês ainda: 'features/tenancy.md'
- Contatos (em Inglês ainda): 'features/contacts.md'
- Pesquisa (Search) - em Inglês ainda: 'features/search.md'
- Dados de Contexto (em Inglês ainda): 'features/context-data.md'
- Logging de Mudanças (em Inglês ainda): 'features/change-logging.md'
- Journaling (em Inglês ainda): 'features/journaling.md'
- Autenticação & Permissões (em Inglês ainda): 'features/authentication-permissions.md'
- Integrações & API (em Inglês ainda): 'features/api-integration.md'
- Customização (em Inglês ainda): 'features/customization.md'
- Instalação & Upgrade:
- Instalando o NetBox: 'installation/index.md'
- 1. PostgreSQL: 'installation/1-postgresql.md'
- 2. Redis: 'installation/2-redis.md'
- 3. NetBox: 'installation/3-netbox.md'
- 4. Gunicorn: 'installation/4-gunicorn.md'
- 5. Servidor HTTP: 'installation/5-http-server.md'
- 6. LDAP (Opcional): 'installation/6-ldap.md'
- Fazendo o Upgrade do NetBox: 'installation/upgrading.md'
- Começando com o NetBox:
- Planejamento: 'getting-started/planning.md'
- Populando o NetBox com Dados: 'getting-started/populating-data.md'
- Configuração (em Inglês ainda):
- Configurando o NetBox (em Inglês ainda): 'configuration/index.md'
- Parâmetros Obrigatórios (em Inglês ainda): 'configuration/required-parameters.md'
- Sistema (em Inglês ainda): 'configuration/system.md'
- Segurança (em Inglês ainda): 'configuration/security.md'
- Autenticação Remota (em Inglês ainda): 'configuration/remote-authentication.md'
- Dados & Validação (em Inglês ainda): 'configuration/data-validation.md'
- Valores Padrão (Default) - em Inglês ainda: 'configuration/default-values.md'
- Registro de Erros (em Inglês ainda): 'configuration/error-reporting.md'
- Plugins (em Inglês ainda): 'configuration/plugins.md'
- NAPALM (em Inglês ainda): 'configuration/napalm.md'
- Data & Hora (em Inglês ainda): 'configuration/date-time.md'
- Diversos (Miscellaneous) - em Inglês ainda: 'configuration/miscellaneous.md'
- Desenvolvimento (em Inglês ainda): 'configuration/development.md'
- Customização :
- Campos Customizados: 'customization/custom-fields.md'
- Links Customizados: 'customization/custom-links.md'
- Validação Customizada: 'customization/custom-validation.md'
- Exportação de Templates: 'customization/export-templates.md'
- Relatórios (Reports): 'customization/reports.md'
- Scripts Customizados: 'customization/custom-scripts.md'
- Integrações:
- API REST: 'integrations/rest-api.md'
- API GraphQL: 'integrations/graphql-api.md'
- Webhooks: 'integrations/webhooks.md'
- NAPALM: 'integrations/napalm.md'
- Métricas do Prometheus: 'integrations/prometheus-metrics.md'
- Plugins:
- Usando Plugins: 'plugins/index.md'
- Desenvolvendo Plugins:
- Começando: 'plugins/development/index.md'
- Modelos: 'plugins/development/models.md'
- Visualizações (Views): 'plugins/development/views.md'
- Navegação: 'plugins/development/navigation.md'
- Templates: 'plugins/development/templates.md'
- Tabelas: 'plugins/development/tables.md'
- Formulários: 'plugins/development/forms.md'
- Filtros & Grupos de Filtro: 'plugins/development/filtersets.md'
- Pesquisa (Search): 'plugins/development/search.md'
- API REST: 'plugins/development/rest-api.md'
- API GraphQL: 'plugins/development/graphql-api.md'
- Tarefas de Fundo (Background): 'plugins/development/background-tasks.md'
- Mudanças Pendentes (Staged): 'plugins/development/staged-changes.md'
- Exceções: 'plugins/development/exceptions.md'
- Proxbox Plugin:
- Proxbox: 'plugins/netbox-proxbox.md'
- Administração (em Inglês ainda):
- Autenticação (em Inglês ainda):
- Visão Geral (em Inglês ainda): 'administration/authentication/overview.md'
- Microsoft Azure AD (em Inglês ainda): 'administration/authentication/microsoft-azure-ad.md'
- Okta (em Inglês ainda): 'administration/authentication/okta.md'
- Permissões (em Inglês ainda): 'administration/permissions.md'
- Registro de Erros (em Inglês ainda): 'administration/error-reporting.md'
- Housekeeping (em Inglês ainda): 'administration/housekeeping.md'
- Replicando o NetBox (em Inglês ainda): 'administration/replicating-netbox.md'
- NetBox Shell (em Inglês ainda): 'administration/netbox-shell.md'
- Modelos de Dados (em Inglês ainda):
- Circuitos (em Inglês ainda):
- Circuito (em Inglês ainda): 'models/circuits/circuit.md'
- Terminação de Circuito (em Inglês ainda): 'models/circuits/circuittermination.md'
- Tipo de Circuito (em Inglês ainda): 'models/circuits/circuittype.md'
- Fornecedor (Provider) - em Inglês ainda: 'models/circuits/provider.md'
- Rede do Fornecedor (Provider) - em Inglês ainda: 'models/circuits/providernetwork.md'
- DCIM (Gerenciamento de Infraestrutura) - em Inglês ainda:
- Cabos (em Inglês ainda): 'models/dcim/cable.md'
- ConsolePort (em Inglês ainda): 'models/dcim/consoleport.md'
- ConsolePortTemplate (em Inglês ainda): 'models/dcim/consoleporttemplate.md'
- ConsoleServerPort (em Inglês ainda): 'models/dcim/consoleserverport.md'
- ConsoleServerPortTemplate (em Inglês ainda): 'models/dcim/consoleserverporttemplate.md'
- Device (em Inglês ainda): 'models/dcim/device.md'
- DeviceBay (em Inglês ainda): 'models/dcim/devicebay.md'
- DeviceBayTemplate (em Inglês ainda): 'models/dcim/devicebaytemplate.md'
- DeviceRole (em Inglês ainda): 'models/dcim/devicerole.md'
- DeviceType (em Inglês ainda): 'models/dcim/devicetype.md'
- FrontPort (em Inglês ainda): 'models/dcim/frontport.md'
- FrontPortTemplate (em Inglês ainda): 'models/dcim/frontporttemplate.md'
- Interface (em Inglês ainda): 'models/dcim/interface.md'
- InterfaceTemplate (em Inglês ainda): 'models/dcim/interfacetemplate.md'
- InventoryItem (em Inglês ainda): 'models/dcim/inventoryitem.md'
- InventoryItemRole (em Inglês ainda): 'models/dcim/inventoryitemrole.md'
- InventoryItemTemplate (em Inglês ainda): 'models/dcim/inventoryitemtemplate.md'
- Location (em Inglês ainda): 'models/dcim/location.md'
- Manufacturer (em Inglês ainda): 'models/dcim/manufacturer.md'
- Module (em Inglês ainda): 'models/dcim/module.md'
- ModuleBay (em Inglês ainda): 'models/dcim/modulebay.md'
- ModuleBayTemplate (em Inglês ainda): 'models/dcim/modulebaytemplate.md'
- ModuleType (em Inglês ainda): 'models/dcim/moduletype.md'
- Platform (em Inglês ainda): 'models/dcim/platform.md'
- PowerFeed (em Inglês ainda): 'models/dcim/powerfeed.md'
- PowerOutlet (em Inglês ainda): 'models/dcim/poweroutlet.md'
- PowerOutletTemplate (em Inglês ainda): 'models/dcim/poweroutlettemplate.md'
- PowerPanel (em Inglês ainda): 'models/dcim/powerpanel.md'
- PowerPort (em Inglês ainda): 'models/dcim/powerport.md'
- PowerPortTemplate (em Inglês ainda): 'models/dcim/powerporttemplate.md'
- Rack (em Inglês ainda): 'models/dcim/rack.md'
- RackReservation (em Inglês ainda): 'models/dcim/rackreservation.md'
- RackRole (em Inglês ainda): 'models/dcim/rackrole.md'
- RearPort (em Inglês ainda): 'models/dcim/rearport.md'
- RearPortTemplate (em Inglês ainda): 'models/dcim/rearporttemplate.md'
- Region (em Inglês ainda): 'models/dcim/region.md'
- Site (em Inglês ainda): 'models/dcim/site.md'
- SiteGroup (em Inglês ainda): 'models/dcim/sitegroup.md'
- VirtualChassis (em Inglês ainda): 'models/dcim/virtualchassis.md'
- VirtualDeviceContext (em Inglês ainda): 'models/dcim/virtualdevicecontext.md'
- Extras (em Inglês ainda):
- Branch (em Inglês ainda): 'models/extras/branch.md'
- ConfigContext (em Inglês ainda): 'models/extras/configcontext.md'
- CustomField (em Inglês ainda): 'models/extras/customfield.md'
- CustomLink (em Inglês ainda): 'models/extras/customlink.md'
- ExportTemplate (em Inglês ainda): 'models/extras/exporttemplate.md'
- ImageAttachment (em Inglês ainda): 'models/extras/imageattachment.md'
- JournalEntry (em Inglês ainda): 'models/extras/journalentry.md'
- SavedFilter (em Inglês ainda): 'models/extras/savedfilter.md'
- StagedChange (em Inglês ainda): 'models/extras/stagedchange.md'
- Tag (em Inglês ainda): 'models/extras/tag.md'
- Webhook (em Inglês ainda): 'models/extras/webhook.md'
- IPAM (Endereçamento IP) - em Inglês ainda:
- ASN (em Inglês ainda): 'models/ipam/asn.md'
- Agregado de Prefixos (Aggregate) em Inglês ainda: 'models/ipam/aggregate.md'
- FHRPGroup (em Inglês ainda): 'models/ipam/fhrpgroup.md'
- FHRPGroupAssignment (em Inglês ainda): 'models/ipam/fhrpgroupassignment.md'
- IPAddress (em Inglês ainda): 'models/ipam/ipaddress.md'
- IPRange (em Inglês ainda): 'models/ipam/iprange.md'
- L2VPN (em Inglês ainda): 'models/ipam/l2vpn.md'
- L2VPNTermination (em Inglês ainda): 'models/ipam/l2vpntermination.md'
- Prefix (em Inglês ainda): 'models/ipam/prefix.md'
- RIR (em Inglês ainda): 'models/ipam/rir.md'
- Role (em Inglês ainda): 'models/ipam/role.md'
- RouteTarget (em Inglês ainda): 'models/ipam/routetarget.md'
- Service (em Inglês ainda): 'models/ipam/service.md'
- ServiceTemplate (em Inglês ainda): 'models/ipam/servicetemplate.md'
- VLAN (em Inglês ainda): 'models/ipam/vlan.md'
- VLANGroup (em Inglês ainda): 'models/ipam/vlangroup.md'
- VRF (em Inglês ainda): 'models/ipam/vrf.md'
- Locação (Tenancy) - em Inglês ainda:
- Contact (em Inglês ainda): 'models/tenancy/contact.md'
- ContactGroup (em Inglês ainda): 'models/tenancy/contactgroup.md'
- ContactRole (em Inglês ainda): 'models/tenancy/contactrole.md'
- Tenant (em Inglês ainda): 'models/tenancy/tenant.md'
- TenantGroup (em Inglês ainda): 'models/tenancy/tenantgroup.md'
- Virtualização (Virtualization) - em Inglês ainda:
- Cluster (em Inglês ainda): 'models/virtualization/cluster.md'
- ClusterGroup (em Inglês ainda): 'models/virtualization/clustergroup.md'
- ClusterType (em Inglês ainda): 'models/virtualization/clustertype.md'
- VMInterface (em Inglês ainda): 'models/virtualization/vminterface.md'
- VirtualMachine (em Inglês ainda): 'models/virtualization/virtualmachine.md'
- Wireless (Wi-Fi) - em Inglês ainda:
- WirelessLAN (em Inglês ainda): 'models/wireless/wirelesslan.md'
- WirelessLANGroup (em Inglês ainda): 'models/wireless/wirelesslangroup.md'
- WirelessLink (em Inglês ainda): 'models/wireless/wirelesslink.md'
- Referência (em Inglês ainda):
- Filtros (em Inglês ainda): 'reference/filtering.md'
- Condições (em Inglês ainda): 'reference/conditions.md'
- Markdown (em Inglês ainda): 'reference/markdown.md'
- Desenvolvimento (em Inglês ainda):
- Introdução (em Inglês ainda): 'development/index.md'
- Começando (em Inglês ainda): 'development/getting-started.md'
- Guia de Estilo (CSS) - em Inglês ainda: 'development/style-guide.md'
- Modelos (em Inglês ainda): 'development/models.md'
- Adicionando Modelos (em Inglês ainda): 'development/adding-models.md'
- Extendendo Modelos (em Inglês ainda): 'development/extending-models.md'
- Sinais (Signals) - em Inglês ainda: 'development/signals.md'
- Pesquisa (Search) - em Inglês ainda: 'development/search.md'
- Registro das Aplicações (em Inglês ainda): 'development/application-registry.md'
- Preferências do Usuário (em Inglês ainda): 'development/user-preferences.md'
- Interface Web (em Inglês ainda): 'development/web-ui.md'
- Checklist da Versão (Release) - em Inglês ainda: 'development/release-checklist.md'
- git Cheat Sheet (em Inglês ainda): 'development/git-cheat-sheet.md'
- Notas da Versão (Release Notes) - em Inglês ainda:
- Resumo (em Inglês ainda): 'release-notes/index.md'
- Versão 3.4 (em Inglês ainda): 'release-notes/version-3.4.md'
- Versão 3.3 (em Inglês ainda): 'release-notes/version-3.3.md'
- Versão 3.2 (em Inglês ainda): 'release-notes/version-3.2.md'
- Versão 3.1 (em Inglês ainda): 'release-notes/version-3.1.md'
- Versão 3.0 (em Inglês ainda): 'release-notes/version-3.0.md'
- Versão 2.11 (em Inglês ainda): 'release-notes/version-2.11.md'
- Versão 2.10 (em Inglês ainda): 'release-notes/version-2.10.md'
- Versão 2.9 (em Inglês ainda): 'release-notes/version-2.9.md'
- Versão 2.8 (em Inglês ainda): 'release-notes/version-2.8.md'
- Versão 2.7 (em Inglês ainda): 'release-notes/version-2.7.md'
- Versão 2.6 (em Inglês ainda): 'release-notes/version-2.6.md'
- Versão 2.5 (em Inglês ainda): 'release-notes/version-2.5.md'
- Versão 2.4 (em Inglês ainda): 'release-notes/version-2.4.md'
- Versão 2.3 (em Inglês ainda): 'release-notes/version-2.3.md'
- Versão 2.2 (em Inglês ainda): 'release-notes/version-2.2.md'
- Versão 2.1 (em Inglês ainda): 'release-notes/version-2.1.md'
- Versão 2.0 (em Inglês ainda): 'release-notes/version-2.0.md'