docs: add document for how to install tianji without docker #56
This commit is contained in:
parent
3d1be2b5e9
commit
fe0b596d29
4
website/docs/install/_category_.json
Normal file
4
website/docs/install/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Install",
|
||||
"position": 2
|
||||
}
|
58
website/docs/install/manual.md
Normal file
58
website/docs/install/manual.md
Normal file
@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Install without docker
|
||||
|
||||
Use docker to install `Tianji` is best way which you dont need consider about enviroment problem.
|
||||
|
||||
But if your server not support dockerize, you can try to install by manual.
|
||||
|
||||
## Requirements
|
||||
|
||||
You need:
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/) 18 / 20.4
|
||||
- [pnpm](https://pnpm.io/) 8.15.3+
|
||||
- [Git](https://git-scm.com/downloads)
|
||||
- [postgresql](https://www.postgresql.org/)
|
||||
- [pm2](https://pm2.keymetrics.io/) - For running Tianji in the background
|
||||
- [apprise](https://github.com/caronc/apprise) - optional, if you need it to notify
|
||||
|
||||
## Clone Code and Build
|
||||
|
||||
```bash
|
||||
git clone https://github.com/msgbyte/tianji.git
|
||||
cd tianji
|
||||
pnpm install
|
||||
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## Prepare Environment File
|
||||
|
||||
Create a `.env` file in `src/server`
|
||||
|
||||
```ini
|
||||
DATABASE_URL="postgresql://user:pass@127.0.0.1:5432/tianji?schema=public&connection_limit=10"
|
||||
JWT_SECRET="replace-me-with-a-random-string"
|
||||
```
|
||||
|
||||
Make sure your database url is correct. and dont remember create database before.
|
||||
|
||||
For more environment can check this document [environment](../environment.md)
|
||||
|
||||
## Run server
|
||||
|
||||
```bash
|
||||
npm install pm2 -g && pm2 install pm2-logrotate
|
||||
|
||||
# Init db migrate
|
||||
cd src/server
|
||||
pnpm db:migrate:apply
|
||||
|
||||
# Start Server
|
||||
pm2 start ./dist/src/server/main.js --name tianji
|
||||
```
|
||||
|
||||
Default, `Tianji` will run on http://localhost:12345
|
@ -1,4 +1,4 @@
|
||||
{
|
||||
"label": "Monitor",
|
||||
"position": 3
|
||||
"position": 13
|
||||
}
|
||||
|
@ -1,4 +1,4 @@
|
||||
{
|
||||
"label": "Server Status",
|
||||
"position": 4
|
||||
"position": 14
|
||||
}
|
||||
|
@ -1,4 +1,4 @@
|
||||
{
|
||||
"label": "Telemetry",
|
||||
"position": 5
|
||||
"position": 15
|
||||
}
|
||||
|
@ -1,4 +1,4 @@
|
||||
{
|
||||
"label": "Website",
|
||||
"position": 2
|
||||
"position": 10
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user