mirror of
https://github.com/0xJacky/nginx-ui.git
synced 2025-05-12 10:55:51 +02:00
chore(devcontainer): update docs
This commit is contained in:
parent
19def6ea3b
commit
d13d9c34e7
6 changed files with 149 additions and 0 deletions
50
docs/guide/devcontainer.md
Normal file
50
docs/guide/devcontainer.md
Normal file
|
@ -0,0 +1,50 @@
|
|||
# Devcontainer
|
||||
|
||||
You'll need to set up a development environment if you want to develop on this project.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Docker
|
||||
- VSCode (Cursor)
|
||||
- Git
|
||||
|
||||
## Setup
|
||||
|
||||
1. Open the Command Palette in VSCode (Cursor)
|
||||
- Mac: `Cmd`+`Shift`+`P`
|
||||
- Windows: `Ctrl`+`Shift`+`P`
|
||||
2. Search for `Dev Containers: Rebuild and Reopen in Container` and click on it
|
||||
3. Wait for the container to start
|
||||
4. Open the Command Palette in VSCode (Cursor)
|
||||
- Mac: `Cmd`+`Shift`+`P`
|
||||
- Windows: `Ctrl`+`Shift`+`P`
|
||||
5. Select Tasks: Run Task -> Start all services
|
||||
6. Wait for the services to start
|
||||
|
||||
## Ports
|
||||
|
||||
| Port | Service |
|
||||
|-------|------------------|
|
||||
| 3002 | App |
|
||||
| 3003 | Documentation |
|
||||
| 9000 | API Backend |
|
||||
|
||||
|
||||
## Services
|
||||
|
||||
- nginx-ui
|
||||
- nginx-ui-2
|
||||
- casdoor
|
||||
- chaltestsrv
|
||||
- pebble
|
||||
|
||||
## Multi-node development
|
||||
|
||||
Add the following enviroment in the main node:
|
||||
|
||||
```
|
||||
name: nginx-ui-2
|
||||
url: http://nginx-ui-2
|
||||
token: nginx-ui-2
|
||||
```
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue