docs: marznode installation and admin guide, contribution guide (#2)

* docs(structure): admins guide, configuration, contribution guide * feat: multi lingual * docs: backend vpns * docs: installation * docs: marzndoe installation and setup
marzneshin · Jul 28, 2024 · 8b10653 · 8b10653
1 parent 0b7f020
commit 8b10653
Show file tree

Hide file tree

Showing 33 changed files with 186 additions and 4 deletions.
diff --git a/content/_index.md b/content/_index.md
@@ -3,11 +3,15 @@ title: Marzneshin
 toc: false
 ---
 
+<br>
+
 A Scalable and Comprehensive Proxy Engine management panel.
 
 ## Explore
 
 {{< cards >}}
-{{< card link="docs" title="Overview" icon="book-open" >}}
+
+{{< card link="docs" title="Documentation" icon="book-open" >}}
 {{< card link="about" title="About" icon="user" >}}
+
 {{< /cards >}}
diff --git a/content/docs/getting-started/installation.md → content/docs/admins-guide/_index.md b/content/docs/getting-started/installation.md → content/docs/admins-guide/_index.md
diff --git a/...ocs/getting-started/what-is-marzneshin.md → ...ns-guide/inbounds-and-hosts-management.md b/...ocs/getting-started/what-is-marzneshin.md → ...ns-guide/inbounds-and-hosts-management.md
diff --git a/content/docs/admins-guide/nodes-management.md b/content/docs/admins-guide/nodes-management.md
diff --git a/content/docs/admins-guide/services-management.md b/content/docs/admins-guide/services-management.md
diff --git a/content/docs/admins-guide/users-management.md b/content/docs/admins-guide/users-management.md
diff --git a/content/docs/configuration/_index.md b/content/docs/configuration/_index.md
@@ -0,0 +1,5 @@
+---
+title: Configuration
+next: marzneshin
+weight: 3
+---
diff --git a/content/docs/configuration/marzneshin.md b/content/docs/configuration/marzneshin.md
diff --git a/content/docs/configuration/marznode.md b/content/docs/configuration/marznode.md
diff --git a/content/docs/configuration/vpn-backends/_index.md b/content/docs/configuration/vpn-backends/_index.md
diff --git a/content/docs/configuration/vpn-backends/hysteria.md b/content/docs/configuration/vpn-backends/hysteria.md
diff --git a/content/docs/configuration/vpn-backends/xray.md b/content/docs/configuration/vpn-backends/xray.md
diff --git a/content/docs/contribution-guide/_index.md b/content/docs/contribution-guide/_index.md
@@ -0,0 +1,4 @@
+---
+title: Developer Guide
+weight: 4
+---
diff --git a/content/docs/contribution-guide/architecture.md b/content/docs/contribution-guide/architecture.md
diff --git a/content/docs/contribution-guide/codebase.md b/content/docs/contribution-guide/codebase.md
diff --git a/content/docs/contribution-guide/support.md b/content/docs/contribution-guide/support.md
diff --git a/content/docs/getting-started/_index.md b/content/docs/getting-started/_index.md
@@ -1,8 +1,9 @@
 ---
 title: Getting Started
 type: docs
-prev: docs/what-is-marzneshin
-next: docs/folder/leaf
+prev: docs/overview
+next: installation
+weight: 2
 sidebar:
   open: true
 ---

diff --git a/content/docs/getting-started/concepts/_index.md b/content/docs/getting-started/concepts/_index.md
@@ -0,0 +1,5 @@
+---
+title: Concepts
+next: users
+prev: docs/installation
+---
diff --git a/content/docs/getting-started/concepts/admins.md b/content/docs/getting-started/concepts/admins.md
@@ -0,0 +1,5 @@
+---
+title: Admins
+prev: inbounds-and-hosts
+weight: 5
+---
diff --git a/content/docs/getting-started/concepts/inbounds-and-hosts.md b/content/docs/getting-started/concepts/inbounds-and-hosts.md
@@ -0,0 +1,5 @@
+---
+title: Inbounds & Hosts
+next: admins
+weight: 4
+---
diff --git a/content/docs/getting-started/concepts/nodes.md b/content/docs/getting-started/concepts/nodes.md
@@ -0,0 +1,5 @@
+---
+title: Nodes
+next: inbounds-and-hosts
+weight: 3
+---
diff --git a/content/docs/getting-started/concepts/services.md b/content/docs/getting-started/concepts/services.md
@@ -0,0 +1,6 @@
+---
+title: Services
+next: nodes
+prev: users
+weight: 2
+---
diff --git a/content/docs/getting-started/concepts/users.md b/content/docs/getting-started/concepts/users.md
@@ -0,0 +1,6 @@
+---
+title: Users
+prev: concepts
+next: services
+weight: 1
+---
diff --git a/content/docs/getting-started/installations/_index.md b/content/docs/getting-started/installations/_index.md
@@ -0,0 +1,5 @@
+---
+title: Installations
+next: marzneshin
+weight: 2
+---
diff --git a/content/docs/getting-started/installations/marzneshin.md b/content/docs/getting-started/installations/marzneshin.md
@@ -0,0 +1,5 @@
+---
+title: Installing Marzneshin
+next: marznode
+weight: 1
+---
diff --git a/content/docs/getting-started/installations/marznode.md b/content/docs/getting-started/installations/marznode.md
@@ -0,0 +1,91 @@
+---
+title: Marznode
+weight: 2
+---
+
+### Prerequesits
+
+- Docker
+- Docker Compose
+
+{{< callout type="info" >}}
+Make sure you have docker installed
+
+```sh
+$ curl -fsSL https://get.docker.com | sh
+```
+
+{{< /callout >}}
+
+{{% steps %}}
+
+### Get Marznode
+
+Clone the marznode repository and spin up the container.
+
+```sh
+$ git clone https://github.com/marzneshin/marznode
+$ cd marznode
+```
+
+### Configure certificate
+
+Copy the marzneshin certificate from dashboard in settings page to `/var/lib/marznode/client.pem`.
+
+### Setup Xray for marznode
+
+Move to `/var/lib/marznode/data`
+
+```sh
+mkdir -p /var/lib/marznode/data
+cd /var/lib/marznode/data
+```
+
+Download the latest [Xray release](https://github.com/XTLS/Xray-core/releases/) for linux
+
+```sh
+wget https://github.com/XTLS/Xray-core/releases/download/v1.8.21/Xray-linux-64.zip
+```
+
+Unzip and clean the Xray file
+
+```sh
+unzip Xray-linux-64.zip && rm Xray-linux-64.zip
+```
+
+### Configure xray
+
+Copy the xray config file:
+
+```sh
+cp /root/marznode/xray_config.json /var/lib/marznode/xray_config.json
+```
+
+Move the data to xray for marznode:
+
+```sh
+cp /var/lib/marznode/data/xray /var/lib/marznode/xray
+```
+
+### Set the environment variables
+
+Based on the current steps, the `.env` file should follow as
+
+```sh
+XRAY_EXECUTABLE_PATH="/var/lib/marznode/xray"
+XRAY_ASSETS_PATH="/var/lib/marznoed/data"
+XRAY_CONFIG_PATH="/var/lib/marznode/xray_config.json"
+SSL_CLIENT_CERT_FILE="/var/lib/marznode/client.pem"
+SSL_KEY_FILE="./server.key"
+SSL_CERT_FILE="./server.cert"
+```
+
+### Spin up docker compose
+
+Execute the following command inside the marznode folder:
+
+```sh
+docker compose up -f ./compose.yml -d
+```
+
+{{% /steps %}}
diff --git a/content/docs/how-to-guide/backup.md b/content/docs/how-to-guide/backup.md
diff --git a/content/docs/how-to-guide/generating-ssl.md b/content/docs/how-to-guide/generating-ssl.md
diff --git a/content/docs/how-to-guide/webhook.md b/content/docs/how-to-guide/webhook.md
diff --git a/content/docs/overview/_index.md b/content/docs/overview/_index.md
@@ -0,0 +1,5 @@
+---
+title: Overview
+next: marzneshin
+weight: 1
+---
diff --git a/content/docs/overview/marzneshin.md b/content/docs/overview/marzneshin.md
@@ -0,0 +1,5 @@
+---
+title: Marzneshin
+next: marznode
+weight: 1
+---
diff --git a/content/docs/overview/marznode.md b/content/docs/overview/marznode.md
@@ -0,0 +1,5 @@
+---
+title: Marznode
+next: getting-started
+weight: 2
+---
diff --git a/hugo.yaml b/hugo.yaml
@@ -1,4 +1,3 @@
-# Hugo configuration file
 title: Marzneshin
 
 # import hextra as module
@@ -49,3 +48,24 @@ params:
   editURL:
     enable: true
     base: "https://github.com/marzneshin/docs/edit/main/content"
+
+defaultContentLanguage: en
+languages:
+  en:
+    languageName: English
+    weight: 1
+  fa:
+    languageName: فارسی
+    weight: 3
+  ru:
+    languageName: Russian
+    weight: 2
+  kmr:
+    languageName: Kurdî Kurmancî
+    weight: 3
+  ckb:
+    languageName: کوردی سورانی
+    weight: 3
+  kur:
+    languageName: Kurdî Soranî
+    weight: 3