Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: versions #212

Merged
merged 1 commit into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

Make sure you have:

- Installed Node.js 18+, Yarn 1.22.x
- Installed Node.js 20+, Yarn 1.22.x
- Configured and started one of the required database MySQL 8.x, MariaDB 10.9+, PostgreSQL 10+

You can download and install the latest LTS version from the official website. It is recommended to use nvm (or nvm-windows for Win systems) to manage Node.js versions if you plan to work with Node.js for a long time.

```bash
$ node -v

v18.19.0
v20.10.0
```

Install yarn package manager
Expand All @@ -28,7 +28,7 @@ $ yarn -v

### Latest version

The most stable version to date, recommended for installation.
Stable and well-tested version and only bug fixed will be made. This version is recommended.

<Tabs>
<div label="PostgreSQL" name="postgres">
Expand Down Expand Up @@ -74,15 +74,15 @@ yarn create nocobase-app my-nocobase-app -d mariadb \
</div>
</Tabs>

### Next version
### Beta version

Alpha version, including some unreleased new features. This version may not be completely stable and is suitable for developers or testers to experience new features in advance or conduct compatibility testing.
This version includes new features that are about to be released and it has been preliminarily tested, but still have known or unknown issues.

<Tabs>
<div label="PostgreSQL" name="postgres">

```bash
npx create-nocobase-app@next my-nocobase-app -d postgres \
npx create-nocobase-app@beta my-nocobase-app -d postgres \
-e DB_HOST=localhost \
-e DB_PORT=5432 \
-e DB_DATABASE=nocobase \
Expand All @@ -96,7 +96,7 @@ npx create-nocobase-app@next my-nocobase-app -d postgres \
<div label="MySQL" name="mysql">

```bash
npx create-nocobase-app@next my-nocobase-app -d mysql \
npx create-nocobase-app@beta my-nocobase-app -d mysql \
-e DB_HOST=localhost \
-e DB_PORT=3306 \
-e DB_DATABASE=nocobase \
Expand All @@ -110,7 +110,55 @@ npx create-nocobase-app@next my-nocobase-app -d mysql \
<div label="MariaDB" name="mariadb">

```bash
npx create-nocobase-app@next my-nocobase-app -d mariadb \
npx create-nocobase-app@beta my-nocobase-app -d mariadb \
-e DB_HOST=localhost \
-e DB_PORT=3306 \
-e DB_DATABASE=nocobase \
-e DB_USER=nocobase \
-e DB_PASSWORD=nocobase \
-e TZ=Asia/Shanghai
```

</div>
</Tabs>

### Alpha version

A development version containing the latest features, which may be incomplete or unstable.

<Tabs>
<div label="PostgreSQL" name="postgres">

```bash
npx create-nocobase-app@alpha my-nocobase-app -d postgres \
-e DB_HOST=localhost \
-e DB_PORT=5432 \
-e DB_DATABASE=nocobase \
-e DB_USER=nocobase \
-e DB_PASSWORD=nocobase \
-e TZ=Asia/Shanghai
```

</div>

<div label="MySQL" name="mysql">

```bash
npx create-nocobase-app@alpha my-nocobase-app -d mysql \
-e DB_HOST=localhost \
-e DB_PORT=3306 \
-e DB_DATABASE=nocobase \
-e DB_USER=nocobase \
-e DB_PASSWORD=nocobase \
-e TZ=Asia/Shanghai
```

</div>

<div label="MariaDB" name="mariadb">

```bash
npx create-nocobase-app@alpha my-nocobase-app -d mariadb \
-e DB_HOST=localhost \
-e DB_PORT=3306 \
-e DB_DATABASE=nocobase \
Expand All @@ -123,10 +171,11 @@ npx create-nocobase-app@next my-nocobase-app -d mariadb \
</Tabs>

:::warning

- `TZ` is used to set the application's time zone, with the default being the system's time zone;
- `APP_KEY` is the application's secret key, used for generating user tokens and so on (if APP_KEY is changed, the old tokens will also become invalid). It can be any random string. Please change it to your own secret key and ensure it is not disclosed to the public.
- `DB_*` is related to the database. If it is not the default database service in the example, please modify it according to the actual situation.
:::
:::

## 2. Switch to the project directory

Expand Down
26 changes: 14 additions & 12 deletions docs/en-US/welcome/getting-started/installation/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The configuration parameters vary slightly depending on the database. Choose the
<div label="PostgreSQL" name="postgres">

```yml
version: "3"
version: '3'

networks:
nocobase:
Expand Down Expand Up @@ -56,7 +56,7 @@ services:
volumes:
- ./storage:/app/nocobase/storage
ports:
- "13000:80"
- '13000:80'
# init: true

# If using an existing database server, postgres service can be omitted
Expand All @@ -79,7 +79,7 @@ services:
<div label="MySQL" name="mysql">

```yml
version: "3"
version: '3'

networks:
nocobase:
Expand Down Expand Up @@ -114,7 +114,7 @@ services:
volumes:
- ./storage:/app/nocobase/storage
ports:
- "13000:80"
- '13000:80'
# init: true

# If using an existing database server, mysql service can be omitted
Expand All @@ -137,7 +137,7 @@ services:
<div label="MariaDB" name="mariadb">

```yml
version: "3"
version: '3'

networks:
nocobase:
Expand Down Expand Up @@ -172,7 +172,7 @@ services:
volumes:
- ./storage:/app/nocobase/storage
ports:
- "13000:80"
- '13000:80'
# init: true

# If using an existing database server, mariadb service can be omitted
Expand All @@ -193,11 +193,12 @@ services:
</div>
</Tabs>

Choose the appropriate NocoBase version:
Choose the appropriate NocoBase version, refer to [versions](./index.md#which-version-to-install)

- `latest` or `main`:The most stable version to date, recommended for installation;
- `next`:Alpha version, including some unreleased new features. This version may not be completely stable and is suitable for developers or testers to experience new features in advance or conduct compatibility testing;
- `1.2.4-alpha`: Specify the version number. To check the latest version, see the [list of released versions](https://hub.docker.com/r/nocobase/nocobase/tags).
- `latest`: Stable and well-tested version and only bug fixed will be made. This version is recommended.
- `beta`: This version includes new features that are about to be released and it has been preliminarily tested, but still have known or unknown issues.
- `alpha`: A development version containing the latest features, which may be incomplete or unstable.
- `1.3.51`: Specify the version number. To check the latest version, see the [list of released versions](https://hub.docker.com/r/nocobase/nocobase/tags).

Example:

Expand All @@ -206,8 +207,9 @@ Example:
services:
app:
image: nocobase/nocobase:latest
image: nocobase/nocobase:next
image: nocobase/nocobase:1.2.4-alpha
image: nocobase/nocobase:beta
image: nocobase/nocobase:alpha
image: nocobase/nocobase:1.3.51
# ...
```

Expand Down
21 changes: 15 additions & 6 deletions docs/en-US/welcome/getting-started/installation/git-clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,35 @@

Make sure you have:

- Git, Node.js 18+, Yarn 1.22.x installed
- Git, Node.js 20+, Yarn 1.22.x installed
- Configured and started the required database &mdash; MySQL 8.x, MariaDB 10.9+, PostgreSQL 10+ &mdash; choose any one.

## 1. Download with Git

### Latest version
### Latest version (`main`)

The most stable version to date, recommended for download.
Stable and well-tested version and only bug fixed will be made. This version is recommended.

```bash
git clone https://github.com/nocobase/nocobase.git -b main --depth=1 my-nocobase
```

### Next version
### Beta version (`next`)

Alpha version, including some unreleased new features. This version may not be completely stable and is suitable for developers or testers to experience new features in advance or conduct compatibility testing.
This version includes new features that are about to be released and it has been preliminarily tested, but still have known or unknown issues.

```bash
git clone https://github.com/nocobase/nocobase.git -b next --depth=1 my-nocobase
```

### Alpha version (`develop`)

A development version containing the latest features, which may be incomplete or unstable.

```bash
git clone https://github.com/nocobase/nocobase.git -b develop --depth=1 my-nocobase
```

## 2. Switch to the project directory

```bash
Expand Down Expand Up @@ -52,10 +60,11 @@ DB_PASSWORD=nocobase
```

:::warning

- `TZ` is used to set the application's time zone, with the default being the system's time zone;
- `APP_KEY` is the application's secret key, used for generating user tokens and so on (if APP_KEY is changed, the old tokens will also become invalid). It can be any random string. Please change it to your own secret key and ensure it is not disclosed to the public.
- `DB_*` is related to the database. If it is not the default database service in the example, please modify it according to the actual situation.
:::
:::

## 5. Install NocoBase

Expand Down
24 changes: 13 additions & 11 deletions docs/en-US/welcome/getting-started/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ NocoBase supports three installation methods.

Suitable for no-code scenarios, no code to write. When upgrading, just download the latest image and reboot.

### create-nocobase-app**
### create-nocobase-app

The business code of the project is completely independent and supports low-code development.

Expand All @@ -24,18 +24,20 @@ If you want to experience the latest unreleased version, or want to participate

## Which version to install?

### Main & Latest version
### Latest version

The most stable version to date, recommended for installation.
This is a stable and well-tested version and only bug fixed will be made. This version is recommended.

### Next version
### Beta version

Alpha version, including some unreleased new features. This version may not be completely stable and is suitable for developers or testers to experience new features in advance or conduct compatibility testing.
This version includes new features that are about to be released and it has been preliminarily tested, but still have known or unknown issues, primarily for testing and feedback. Ideal for early testers willing to try new features and provide feedback.

### Other released versions
### Alpha version

- v1.2.13-alpha
- v1.2.12-alpha
- v1.2.11-alpha
- v1.2.10-alpha
- v1.2.9-alpha
A development version containing the latest features, which may be incomplete or unstable. Suitable for technical users interested in cutting-edge features. Not recommended for production use.

| Version | Source code branch | Docker images version | create-nocobase-app version | Specific version |
| -------- | ------------------ | -------------------------- | ---------------------------- | -------------------------------------------- |
| `Latest` | `main` | `nocobase/nocobase:latest` | `create-nocobase-app@latest` | `1.3.51`<br />`1.3.52`<br />... |
| `Beta` | `next` | `nocobase/nocobase:beta` | `create-nocobase-app@beta` | `1.4.0-beta.1`<br/>`1.4.0-beta.2`<br />... |
| `Alpha` | `develop` | `nocobase/nocobase:alpha` | `create-nocobase-app@alpha` | `1.5.0-alpha.1`<br/>`1.5.0-alpha.2`<br />... |
Loading
Loading