Skip to content

Commit 27394f6

Browse files
committed
chore(docs) : update installation optional parameters to pass in to the installation script
1 parent 2e3ae2f commit 27394f6

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

docs/install/index.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,31 @@ Welcome to the Nixopus installation guide. This section will help you set up Nix
55
To install Nixopus on your VPS, ensure you have sudo access and run the following command:
66

77
```
8-
curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install.sh | sudo bash
8+
sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install.sh)"
99
```
1010

11-
> **Note**: The installation script has not been tested in all distributions and different operating systems. If you encounter any issues during installation, please create an issue on our [GitHub repository](https://github.com/raghavyuva/nixopus/issues) with details about your environment and the error message you received.
11+
## Optional Parameters
12+
13+
You can customize your installation by providing the following optional parameters:
14+
15+
- `--api-domain`: Specify the domain where the Nixopus API will be accessible (e.g., `nixopusapi.example.tld`)
16+
- `--app-domain`: Specify the domain where the Nixopus app will be accessible (e.g., `nixopus.example.tld`)
17+
- `--email` or `-e`: Set the email for the admin account
18+
- `--password` or `-p`: Set the password for the admin account
19+
20+
Example with optional parameters:
21+
```
22+
sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install.sh)" -- \
23+
--api-domain nixopusapi.example.tld \
24+
--app-domain nixopus.example.tld \
25+
26+
--password Adminpassword@123 \
27+
--env production
28+
```
29+
30+
## Accessing Nixopus
31+
32+
After successful installation, you can access the Nixopus dashboard by visiting the URL you specified in the `--app-domain` parameter (e.g., `https://nixopus.example.tld`). Use the email and password you provided during installation to log in.
33+
34+
> **Note**: The installation script has not been tested in all distributions and different operating systems. If you encounter any issues during installation, please create an issue on our [GitHub repository](https://github.com/raghavyuva/nixopus/issues) with details about your environment and the error message you received.
35+

0 commit comments

Comments
 (0)