neon_arch
commited on
Commit
•
87ac0b7
1
Parent(s):
f7c1df2
docs: fix the installation instructions
Browse files- docs/installation.md +5 -5
docs/installation.md
CHANGED
@@ -34,6 +34,7 @@ To get started with Websurfx, clone the repository, edit the config file which i
|
|
34 |
```shell
|
35 |
git clone https://github.com/neon-mmd/websurfx.git
|
36 |
cd websurfx
|
|
|
37 |
cargo build -r
|
38 |
redis-server --port 8082 &
|
39 |
./target/release/websurfx
|
@@ -50,7 +51,6 @@ If you want to use the rolling/edge branch, run the following commands instead:
|
|
50 |
```shell
|
51 |
git clone https://github.com/neon-mmd/websurfx.git
|
52 |
cd websurfx
|
53 |
-
git checkout rolling
|
54 |
cargo build -r
|
55 |
redis-server --port 8082 &
|
56 |
./target/release/websurfx
|
@@ -64,7 +64,7 @@ If you want to change the port or the ip or any other configuration setting chec
|
|
64 |
|
65 |
Before you start, you will need [Docker](https://docs.docker.com/get-docker/) installed on your system first.
|
66 |
|
67 |
-
##
|
68 |
|
69 |
First clone the the repository by running the following command:
|
70 |
|
@@ -111,14 +111,14 @@ docker compose up -d --build
|
|
111 |
|
112 |
This will take around 5-10 mins for first deployment, afterwards the docker build stages will be cached so it will be faster to be build from next time onwards. After the above step finishes launch your preferred browser and then navigate to `http://<ip_address_of_the_device>:<whatever_port_you_provided_in_the_config>`.
|
113 |
|
114 |
-
##
|
115 |
|
116 |
-
For the
|
117 |
|
118 |
```bash
|
119 |
git clone https://github.com/neon-mmd/websurfx.git
|
120 |
cd websurfx
|
121 |
-
git checkout
|
122 |
```
|
123 |
|
124 |
[⬅️ Go back to Home](./README.md)
|
|
|
34 |
```shell
|
35 |
git clone https://github.com/neon-mmd/websurfx.git
|
36 |
cd websurfx
|
37 |
+
git checkout stable
|
38 |
cargo build -r
|
39 |
redis-server --port 8082 &
|
40 |
./target/release/websurfx
|
|
|
51 |
```shell
|
52 |
git clone https://github.com/neon-mmd/websurfx.git
|
53 |
cd websurfx
|
|
|
54 |
cargo build -r
|
55 |
redis-server --port 8082 &
|
56 |
./target/release/websurfx
|
|
|
64 |
|
65 |
Before you start, you will need [Docker](https://docs.docker.com/get-docker/) installed on your system first.
|
66 |
|
67 |
+
## Unstable/Edge/Rolling
|
68 |
|
69 |
First clone the the repository by running the following command:
|
70 |
|
|
|
111 |
|
112 |
This will take around 5-10 mins for first deployment, afterwards the docker build stages will be cached so it will be faster to be build from next time onwards. After the above step finishes launch your preferred browser and then navigate to `http://<ip_address_of_the_device>:<whatever_port_you_provided_in_the_config>`.
|
113 |
|
114 |
+
## Stable
|
115 |
|
116 |
+
For the stable version, follow the same steps as above (as mentioned for the unstable/rolling/edge version) with an addition of one command which has to be performed after cloning and changing directory into the repository which makes the cloning step as follows:
|
117 |
|
118 |
```bash
|
119 |
git clone https://github.com/neon-mmd/websurfx.git
|
120 |
cd websurfx
|
121 |
+
git checkout stable
|
122 |
```
|
123 |
|
124 |
[⬅️ Go back to Home](./README.md)
|