Skip to content

Commit a7b15d7

Browse files
LasimLasim
authored
Merge pull request #304 from deploystackio/fix/self-hosted-update
docs: Update development and self-hosted documentation for setup inst…
2 parents d68be18 + cc47740 commit a7b15d7

File tree

4 files changed

+79
-27
lines changed

4 files changed

+79
-27
lines changed

‎development/backend/index.mdx‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,22 @@ The DeployStack backend is a modern, high-performance Node.js application built
2323
```bash
2424
cd services/backend
2525
npm install
26+
27+
# Start PostgreSQL (requires Docker)
28+
npm run postgres:local
29+
30+
# Configure environment
31+
cp .env.example .env
32+
33+
# Start development server
2634
npm run dev
2735
```
2836

29-
The development server starts at `http://localhost:3000` with API documentation at `/documentation`.
37+
The development server starts at `http://localhost:3000`.
38+
39+
<Info>
40+
On first run, visit `http://localhost:5173/setup` (frontend) to initialize the database and create your admin account.
41+
</Info>
3042

3143
## Development Guides
3244

‎development/index.mdx‎

Lines changed: 61 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -53,30 +53,70 @@ DeployStack implements an MCP-as-a-Service architecture that eliminates installa
5353
- Node.js 18 or higher
5454
- npm 8 or higher
5555
- Git for version control
56-
- DeployStack account at [cloud.deploystack.io](https://cloud.deploystack.io) (for satellite testing)
56+
- Docker (for local PostgreSQL)
5757

5858
### Quick Setup
5959

60-
```bash
61-
# Clone the repository
62-
git clone https://github.com/deploystackio/deploystack.git
63-
cd deploystack
64-
65-
# Install dependencies for all services
66-
cd services/frontend && npm install
67-
cd ../backend && npm install
68-
cd ../satellite && npm install
69-
70-
# Start development servers (in separate terminals)
71-
# Terminal 1 - Backend
72-
cd services/backend && npm run dev # http://localhost:3000
73-
74-
# Terminal 2 - Frontend
75-
cd services/frontend && npm run dev # http://localhost:5173
76-
77-
# Terminal 3 - Satellite (for local satellite testing)
78-
cd services/satellite && npm run dev # http://localhost:9095
79-
```
60+
<Steps>
61+
<Step title="Clone Repository">
62+
```bash
63+
git clone https://github.com/deploystackio/deploystack.git
64+
cd deploystack
65+
```
66+
</Step>
67+
68+
<Step title="Start PostgreSQL (Terminal 1)">
69+
```bash
70+
cd services/backend
71+
npm install
72+
npm run postgres:local
73+
```
74+
75+
This starts PostgreSQL 18 in Docker with default credentials (`deploystack`/`deploystack`).
76+
</Step>
77+
78+
<Step title="Configure and Start Backend (Terminal 1)">
79+
```bash
80+
cp .env.example .env
81+
npm run dev
82+
```
83+
84+
Backend runs at http://localhost:3000
85+
</Step>
86+
87+
<Step title="Complete Setup Wizard">
88+
Open http://localhost:5173/setup in your browser to:
89+
- Initialize the database
90+
- Create your admin account
91+
- Configure basic settings
92+
</Step>
93+
94+
<Step title="Start Frontend (Terminal 2)">
95+
```bash
96+
cd services/frontend
97+
npm install
98+
npm run dev
99+
```
100+
101+
Frontend runs at http://localhost:5173
102+
</Step>
103+
104+
<Step title="Start Satellite (Terminal 3 - Optional)">
105+
```bash
106+
cd services/satellite
107+
npm install
108+
cp .env.example .env
109+
# Edit .env: add DEPLOYSTACK_REGISTRATION_TOKEN from admin panel
110+
npm run dev
111+
```
112+
113+
Satellite runs at http://localhost:3001
114+
115+
<Info>
116+
To get a registration token, go to Admin → Satellites → Pairing in the DeployStack UI after completing the setup wizard.
117+
</Info>
118+
</Step>
119+
</Steps>
80120

81121
## Development Workflow
82122

‎self-hosted/quick-start.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The fastest way to get DeployStack backend and frontend running with proper netw
5252

5353
<Step title="Create Admin Account">
5454
When opening the frontend, you will be redirected to `http://localhost:8080/login`
55-
- Go to "Create Account" to set up your admin user ([read more about user types](/roles))
55+
- Go to "Create Account" to set up your admin user ([read more about user types](/general/roles))
5656
- Login with your new admin account
5757
</Step>
5858

@@ -422,9 +422,9 @@ If you need assistance:
422422
### Learn More
423423

424424
- **[Self-Hosted Documentation](/self-hosted)**: Comprehensive deployment guides
425-
- **[Local Development](/local-setup)**: Set up development environment
426-
- **[Global Settings](/global-settings)**: Configure email, auth, and more
427-
- **[User Roles](/roles)**: Manage team permissions
425+
- **[Local Development](/general/local-setup)**: Set up development environment
426+
- **[Global Settings](/general/global-settings)**: Configure email, auth, and more
427+
- **[User Roles](/general/roles)**: Manage team permissions
428428

429429
---
430430

‎self-hosted/setup.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,4 +406,4 @@ tar xzf deploystack-backup-20250108.tar.gz
406406

407407
---
408408

409-
**Next Steps**: After completing platform setup, configure [user roles and permissions](/roles) and set up your first [team workspaces](/teams).
409+
**Next Steps**: After completing platform setup, configure [user roles and permissions](/general/roles) and set up your first [team workspaces](/general/teams).

0 commit comments

Comments
 (0)