Skip to content

Commit 8131e9d

Browse files
fnalwaysfnalways
authored
Merge pull request #134 from fnalways/chore/improve-readability
misc: improve readability for installation docs
2 parents 4a99226 + 9762698 commit 8131e9d

28 files changed

+201
-453
lines changed

Diff for: ‎docs/.vitepress/en.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -59,26 +59,26 @@ const side = {
5959
collapsed: true,
6060
items: [
6161
{
62-
text: "Using Docker image (recommended)",
63-
link: "/manual/get-started/install-olares-mac-via-docker-image",
62+
text: "Using the script (recommended)",
63+
link: "/manual/get-started/install-olares-mac",
6464
},
6565
{
66-
text: "Using the script",
67-
link: "/manual/get-started/install-olares-mac",
66+
text: "Using Docker image",
67+
link: "/manual/get-started/install-olares-mac-via-docker-image",
6868
},
6969
],
7070
},
7171
{
72-
text: "Windows (WSL)",
72+
text: "Windows (WSL 2)",
7373
collapsed: true,
7474
items: [
7575
{
76-
text: "Using Docker image (recommended)",
77-
link: "/manual/get-started/install-olares-windows-via-docker-image",
76+
text: "Using the script (recommended)",
77+
link: "/manual/get-started/install-olares-windows",
7878
},
7979
{
80-
text: "Using the script",
81-
link: "/manual/get-started/install-olares-windows",
80+
text: "Using Docker image",
81+
link: "/manual/get-started/install-olares-windows-via-docker-image",
8282
},
8383
],
8484
},

Diff for: ‎docs/.vitepress/zh.ts

+10-10
Original file line numberDiff line numberDiff line change
@@ -59,26 +59,26 @@ const side = {
5959
collapsed: true,
6060
items: [
6161
{
62-
text: "使用 Docker 镜像（推荐）",
63-
link: "/zh/manual/get-started/install-olares-mac-via-docker-image",
62+
text: "使用脚本（推荐）",
63+
link: "/zh/manual/get-started/install-olares-mac",
6464
},
6565
{
66-
text: "使用脚本",
67-
link: "/zh/manual/get-started/install-olares-mac",
66+
text: "使用 Docker 镜像",
67+
link: "/zh/manual/get-started/install-olares-mac-via-docker-image",
6868
},
6969
],
7070
},
7171
{
72-
text: "Windows (WSL)",
72+
text: "Windows (WSL 2)",
7373
collapsed: true,
7474
items: [
7575
{
76-
text: "使用 Docker 镜像（推荐）",
77-
link: "/zh/manual/get-started/install-olares-windows-via-docker-image",
76+
text: "使用脚本（推荐）",
77+
link: "/zh/manual/get-started/install-olares-windows",
7878
},
7979
{
80-
text: "使用脚本",
81-
link: "/zh/manual/get-started/install-olares-windows",
80+
text: "使用 Docker 镜像",
81+
link: "/zh/manual/get-started/install-olares-windows-via-docker-image",
8282
},
8383
],
8484
},
@@ -301,7 +301,7 @@ const side = {
301301
},
302302
{
303303
text: "修改 Hosts 配置",
304-
link: "/manual/tasks/set-up-hosts",
304+
link: "/zh/manual/tasks/set-up-hosts",
305305
},
306306
{
307307
text: "升级",

Diff for: ‎docs/code-snippets/docker-compose-GPU.yaml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
services:
2+
olares:
3+
image: beclab/olares:${VERSION}
4+
privileged: true
5+
volumes:
6+
- oic-data:/var
7+
ports:
8+
- "80:80"
9+
- "443:443"
10+
- "30180:30180"
11+
- "18088:18088"
12+
- "41641:41641/udp"
13+
environment:
14+
- HOST_IP=${HOST_IP}
15+
deploy:
16+
resources:
17+
reservations:
18+
devices:
19+
- driver: nvidia
20+
count: 1
21+
capabilities: [gpu]
22+
23+
olaresd-proxy:
24+
image: beclab/olaresd:proxy-v0.1.0
25+
network_mode: host
26+
depends_on:
27+
olares:
28+
condition: service_started
29+
30+
volumes:
31+
oic-data:

Diff for: ‎docs/code-snippets/docker-compose.yaml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
services:
2+
olares:
3+
image: beclab/olares:${VERSION}
4+
privileged: true
5+
volumes:
6+
- oic-data:/var
7+
ports:
8+
- "80:80"
9+
- "443:443"
10+
- "30180:30180"
11+
- "18088:18088"
12+
- "41641:41641/udp"
13+
environment:
14+
- HOST_IP=${HOST_IP}
15+
16+
olaresd-proxy:
17+
image: beclab/olaresd:proxy-v0.1.0
18+
network_mode: host
19+
depends_on:
20+
olares:
21+
condition: service_started
22+
23+
volumes:
24+
oic-data:

Diff for: ‎docs/code-snippets/docker-daemon.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"registry-mirrors": [
3+
"https://mirrors.joinolares.cn"
4+
],
5+
6+
"features": {
7+
"containerd-snapshotter": false
8+
}
9+
}

Diff for: ‎docs/manual/get-started/install-olares-docker.md

-92
This file was deleted.

Diff for: ‎docs/manual/get-started/install-olares-linux-via-docker-compose.md

+14-70
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ description: Learn how to deploy Olares on a Linux server using Docker Compose.
55
# Install Olares on Linux using Docker Compose
66
You can use Docker to install and run Olares in a containerized environment. This guide walks you through setting up Olares with Docker, preparing the installation environment, completing the activation process, and managing the container lifecycle.
77

8-
:::tip
9-
It's recommended to [install Olares on Linux using script](install-olares-linux.md)。
10-
:::
118
## System requirements
129

1310
Make sure your device meets the following requirements.
@@ -23,10 +20,17 @@ Make sure your device meets the following requirements.
2320
While these specific versions are confirmed to work, the process may still work on other versions. Adjustments may be necessary depending on your environment. If you meet any issues with these platforms, feel free to raise an issue on [GitHub](https://github.com/beclab/Olares/issues/new).
2421
:::
2522

26-
## Before you start
23+
## Before you begin
2724
Before you begin, ensure the following:
2825
- [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) are installed and running on your system.
2926
- You know the IP address of the current device.
27+
:::tip Verify host IP
28+
To verify your host IP, run the following command in the terminal:
29+
```bash
30+
ip r
31+
```
32+
Look for the line starting with `default via`. It will show the default gateway and the network interface being used.
33+
:::
3034
- You have [created an Olares ID via LarePass](create-olares-id.md).
3135

3236
## Create a new directory
@@ -37,73 +41,13 @@ mkdir ~/olares-config
3741
cd ~/olares-config
3842
```
3943
## Prepare `docker-compose.yaml`
40-
1. Create a `docker-compose.yaml` file in the `olares-config` directory:
41-
```bash
42-
nano docker-compose.yaml
43-
```
44-
2. Add the following content to the file:
45-
::: code-group
46-
```yaml [Without GPU support]
47-
services:
48-
olares:
49-
image: beclab/olares:${VERSION}
50-
privileged: true
51-
volumes:
52-
- oic-data:/var
53-
ports:
54-
- "80:80"
55-
- "443:443"
56-
- "30180:30180"
57-
- "18088:18088"
58-
- "41641:41641/udp"
59-
environment:
60-
- HOST_IP=${HOST_IP}
61-
62-
olaresd-proxy:
63-
image: beclab/olaresd:proxy-v0.1.0
64-
network_mode: host
65-
depends_on:
66-
olares:
67-
condition: service_started
68-
69-
volumes:
70-
oic-data:
71-
```
72-
```yaml [With GPU support]
73-
services:
74-
olares:
75-
image: beclab/olares:${VERSION}
76-
privileged: true
77-
volumes:
78-
- oic-data:/var
79-
ports:
80-
- "80:80"
81-
- "443:443"
82-
- "30180:30180"
83-
- "18088:18088"
84-
- "41641:41641/udp"
85-
environment:
86-
- HOST_IP=${HOST_IP}
87-
deploy:
88-
resources:
89-
reservations:
90-
devices:
91-
- driver: nvidia
92-
count: 1
93-
capabilities: [gpu]
94-
95-
olaresd-proxy:
96-
image: beclab/olaresd:proxy-v0.1.0
97-
network_mode: host
98-
depends_on:
99-
olares:
100-
condition: service_started
101-
102-
volumes:
103-
oic-data:
104-
```
44+
1. Create a `docker-compose.yaml` file in the `olares-config` directory.
45+
2. Add the appropriate content to the file based on whether GPU support is required:
46+
:::code-group
47+
<<< @/code-snippets/docker-compose.yaml
48+
<<< @/code-snippets/docker-compose-GPU.yaml
10549
:::
106-
3. Save and exit the file by pressing `CTRL+O`, `ENTER`, and `CTRL+X`.
50+
3. Save the `docker-compose.yaml` file.
10751

10852
## Set up environment variables and start container
10953

Diff for: ‎docs/manual/get-started/install-olares-linux.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,8 @@
22
description: Detailed instructions for installing Olares on Linux systems including Ubuntu and Debian. Covers system requirements, installation steps, and activation process.
33
---
44
# Install Olares on Linux via the script
5-
Olares is designed to run on Linux-based systems and has been verified on the following platforms:
5+
This guide explains how to install Olares on Linux using the provided installation script.
66

7-
- Linux distributions: Debian, Ubuntu, Raspbian (a Debian-based system for Raspberry Pi)
8-
- Virtualization platforms: Proxmox VE (PVE, Debian-based), LXC on PVE.
9-
107
## System requirements
118

129
Make sure your device meets the following requirements.

Diff for: ‎docs/manual/get-started/install-olares-lxc.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Instructions for installing Olares on Linux Containers (LXC) including container setup, system requirements, and activation steps.
33
---
44
# Install Olares on LXC
5-
Olares is designed to run on Linux-based systems and has been verified on the following platforms:
6-
7-
- Linux distributions: Debian, Ubuntu, Raspbian (a Debian-based system for Raspberry Pi)
8-
- Virtualization platforms: Proxmox VE (PVE, Debian-based), LXC on PVE.
9-
10-
## System requirements
11-
125
LXC (Linux Containers) is a lightweight virtualization method that runs applications in isolated containers. When used on PVE, it enables an efficient way to deploy Olares without the overhead of a full virtual machine.
136

7+
## System requirements
148
Make sure your device meets the following requirements.
159

1610
- CPU: At least 4 cores

0 commit comments

Comments
 (0)