diff --git a/content/_index.md b/content/_index.md index c1f44f5..d70850f 100644 --- a/content/_index.md +++ b/content/_index.md @@ -3,11 +3,15 @@ title: Marzneshin toc: false --- +
+ 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 b/content/docs/admins-guide/_index.md similarity index 100% rename from content/docs/getting-started/installation.md rename to content/docs/admins-guide/_index.md diff --git a/content/docs/getting-started/what-is-marzneshin.md b/content/docs/admins-guide/inbounds-and-hosts-management.md similarity index 100% rename from content/docs/getting-started/what-is-marzneshin.md rename to content/docs/admins-guide/inbounds-and-hosts-management.md diff --git a/content/docs/admins-guide/nodes-management.md b/content/docs/admins-guide/nodes-management.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/admins-guide/services-management.md b/content/docs/admins-guide/services-management.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/admins-guide/users-management.md b/content/docs/admins-guide/users-management.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/configuration/_index.md b/content/docs/configuration/_index.md new file mode 100644 index 0000000..b4ad2d5 --- /dev/null +++ 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 new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/configuration/marznode.md b/content/docs/configuration/marznode.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/configuration/vpn-backends/_index.md b/content/docs/configuration/vpn-backends/_index.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/configuration/vpn-backends/hysteria.md b/content/docs/configuration/vpn-backends/hysteria.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/configuration/vpn-backends/xray.md b/content/docs/configuration/vpn-backends/xray.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/contribution-guide/_index.md b/content/docs/contribution-guide/_index.md new file mode 100644 index 0000000..6f5f97a --- /dev/null +++ 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 new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/contribution-guide/codebase.md b/content/docs/contribution-guide/codebase.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/contribution-guide/support.md b/content/docs/contribution-guide/support.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/getting-started/_index.md b/content/docs/getting-started/_index.md index 48a7aeb..2f94970 100644 --- 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 index e69de29..68498ef 100644 --- 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 index e69de29..65dade5 100644 --- 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 index e69de29..97206e4 100644 --- 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 index e69de29..db3e8b6 100644 --- 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 index e69de29..e1ea1e9 100644 --- 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 index e69de29..176460f 100644 --- 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 new file mode 100644 index 0000000..e2f2dde --- /dev/null +++ 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 new file mode 100644 index 0000000..b78ce7f --- /dev/null +++ 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 new file mode 100644 index 0000000..a0605d2 --- /dev/null +++ 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 new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/how-to-guide/generating-ssl.md b/content/docs/how-to-guide/generating-ssl.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/how-to-guide/webhook.md b/content/docs/how-to-guide/webhook.md new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/overview/_index.md b/content/docs/overview/_index.md new file mode 100644 index 0000000..ccdf180 --- /dev/null +++ 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 new file mode 100644 index 0000000..239408e --- /dev/null +++ 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 new file mode 100644 index 0000000..2d046ec --- /dev/null +++ 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 index 3bc0464..6367d34 100644 --- 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