Update README.md. Remove deploy and docker. Add zip and unzip to dependencies
This commit is contained in:
@@ -18,6 +18,7 @@ An admin dashboard for Wireguard — manage hosts, clients, tunnels, and IP rule
|
||||
- **Bun** 1.3.1 or later ([install](https://bun.sh/install))
|
||||
- **SQLite** (via `@moduletrace/bun-sqlite`)
|
||||
- **git**
|
||||
- **zip** and **unzip**
|
||||
- **Linux** (Debian, Ubuntu, Fedora, Arch, Alpine, or similar)
|
||||
- Root access (for installation script and system service setup)
|
||||
|
||||
@@ -51,21 +52,6 @@ The install script will:
|
||||
8. Install the `wg-quick` helper script
|
||||
9. Set up a systemd or OpenRC service (`wgui`)
|
||||
|
||||
### Docker
|
||||
|
||||
Build and run with the provided Dockerfile:
|
||||
|
||||
```bash
|
||||
docker build -t wireguard-ui .
|
||||
docker run -d --name wireguard-ui \
|
||||
-p 10752:10752 \
|
||||
-v wgui-data:/app/db \
|
||||
--restart unless-stopped \
|
||||
wireguard-ui
|
||||
```
|
||||
|
||||
The entrypoint (`entrypoint.sh`) installs dependencies and starts the server.
|
||||
|
||||
### Manual (Development)
|
||||
|
||||
```bash
|
||||
@@ -154,12 +140,8 @@ wireguard-ui/
|
||||
├── db/
|
||||
│ ├── schema.ts # Database schema definition
|
||||
│ └── types/db.ts # Generated database types
|
||||
├── deploy/
|
||||
│ └── deploy-prod.sh # Production deployment script (rsync + Docker)
|
||||
├── public/ # Static assets served by the server
|
||||
├── assets/ # Project assets
|
||||
├── Dockerfile # Container image (oven/bun:1.3.1-debian)
|
||||
├── entrypoint.sh # Docker entrypoint
|
||||
├── bun-sqlite.config.ts # Database configuration
|
||||
├── bunext.config.ts # Bunext configuration
|
||||
├── package.json # Dependencies and scripts
|
||||
@@ -188,36 +170,6 @@ Generate types from the schema:
|
||||
bun run db:schema
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
### Production Deployment
|
||||
|
||||
The deployment script (`deploy/deploy-prod.sh`) handles production deployment:
|
||||
|
||||
```bash
|
||||
SOURCE_DIRECTORY=/path/to/wireguard-ui bun run deploy:prod
|
||||
```
|
||||
|
||||
This will:
|
||||
|
||||
1. Rsync the project files to the production server (`[email protected]:/docker/bunext-mariadb`)
|
||||
2. SSH into the server, rebuild the Docker image, and restart the container
|
||||
|
||||
### Docker Production
|
||||
|
||||
The Docker image (`Dockerfile`) is based on `oven/bun:1.3.1-debian`:
|
||||
|
||||
```bash
|
||||
docker build -t bunext-mariadb .
|
||||
docker run --name bunext-mariadb -d \
|
||||
--network cloudflare --network mariadb \
|
||||
-v server-data:/data \
|
||||
--restart unless-stopped \
|
||||
bunext-mariadb:latest
|
||||
```
|
||||
|
||||
The server runs on the port defined in `SiteData.ServerPort` (default: **10752**).
|
||||
|
||||
## Admin Route Hierarchy
|
||||
|
||||
| Route Pattern | Access | Features |
|
||||
|
||||
Reference in New Issue
Block a user