From b6ad518e2214c7efbde46056c280239bd13883f4 Mon Sep 17 00:00:00 2001 From: Mardin <54506351+Krr0ptioN@users.noreply.github.com> Date: Mon, 29 Jul 2024 19:33:51 +0300 Subject: [PATCH 1/5] fix(contribution-guideline): duplicate title contribution guideline (#6) --- content/docs/contribution-guideline/_index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/docs/contribution-guideline/_index.md b/content/docs/contribution-guideline/_index.md index cde9564..900b2d5 100644 --- a/content/docs/contribution-guideline/_index.md +++ b/content/docs/contribution-guideline/_index.md @@ -3,8 +3,6 @@ title: Contribution Guideline weight: 4 --- -# Contribution Guideline - This series of documents is dedicated to people whom want to understand the codebase, architecture, and the contribution guideline. From 36f3f39ee28e85f9c6e8007eee1b683990882db7 Mon Sep 17 00:00:00 2001 From: Dawsh Date: Tue, 30 Jul 2024 10:58:28 +0330 Subject: [PATCH 2/5] add identifiers and translate the menu to farsi --- hugo.yaml | 17 ++++++++++++----- i18n/fa.yaml | 4 ++++ 2 files changed, 16 insertions(+), 5 deletions(-) create mode 100644 i18n/fa.yaml diff --git a/hugo.yaml b/hugo.yaml index 6367d34..d465020 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -17,20 +17,25 @@ markup: menu: main: - - name: Docs + - identifier: documentation + name: Docs pageRef: /docs weight: 1 - - name: About + - identifier: about + name: About pageRef: /about weight: 2 - - name: Contact ↗ + - identifier: contact + name: Contact ↗ url: "https://github.com/marzneshin" weight: 3 - - name: Search + - identifier: search + name: Search weight: 4 params: type: search - - name: GitHub + - identifier: github + name: GitHub weight: 5 url: "https://github.com/marzneshin/marzneshin" params: @@ -56,6 +61,8 @@ languages: weight: 1 fa: languageName: فارسی + languageDirection: rtl + title: مرزنشین weight: 3 ru: languageName: Russian diff --git a/i18n/fa.yaml b/i18n/fa.yaml new file mode 100644 index 0000000..6be9257 --- /dev/null +++ b/i18n/fa.yaml @@ -0,0 +1,4 @@ +documentation: مستندات +about: درباره +contact: ارتباط +github: گیت‌هاب \ No newline at end of file From 1a99ae6e0b4f1b716acee9fae75467c9d2af42eb Mon Sep 17 00:00:00 2001 From: Dawsh Date: Tue, 30 Jul 2024 11:35:01 +0330 Subject: [PATCH 3/5] simplify marznode installation docs --- .../getting-started/installations/marznode.md | 66 +++++-------------- 1 file changed, 18 insertions(+), 48 deletions(-) diff --git a/content/docs/getting-started/installations/marznode.md b/content/docs/getting-started/installations/marznode.md index a0605d2..fabefce 100644 --- a/content/docs/getting-started/installations/marznode.md +++ b/content/docs/getting-started/installations/marznode.md @@ -3,7 +3,7 @@ title: Marznode weight: 2 --- -### Prerequesits +### Prerequisites - Docker - Docker Compose @@ -12,79 +12,49 @@ weight: 2 Make sure you have docker installed ```sh -$ curl -fsSL https://get.docker.com | sh +curl -fsSL https://get.docker.com | sh ``` {{< /callout >}} {{% steps %}} -### Get Marznode -Clone the marznode repository and spin up the container. +### Setup your certificate +Create the necessary directory ```sh -$ git clone https://github.com/marzneshin/marznode -$ cd marznode +mkdir -p /var/lib/marznode/ ``` -### Configure certificate - -Copy the marzneshin certificate from dashboard in settings page to `/var/lib/marznode/client.pem`. - -### Setup Xray for marznode +And get your certificate from marzneshin settings, place it here: -Move to `/var/lib/marznode/data` - -```sh -mkdir -p /var/lib/marznode/data -cd /var/lib/marznode/data -``` +`/var/lib/marznode/client.pem` -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 -``` +### Setup some xray config -Unzip and clean the Xray file +Provide some xray config for your node; you could modify it later in the dashboard. +We setup the sample config from marznode repository in this case: ```sh -unzip Xray-linux-64.zip && rm Xray-linux-64.zip +curl https://github.com/khodedawsh/marznode/raw/master/xray_config.json > /var/lib/marznode/xray_config.json ``` -### 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 +### Get Marznode -Based on the current steps, the `.env` file should follow as +To clone marznode ```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" +git clone https://github.com/khodedawsh/marznode +cd marznode ``` -### Spin up docker compose +### Spin up the container -Execute the following command inside the marznode folder: +Execute the following command to get your node up and running -```sh +```shell docker compose up -f ./compose.yml -d ``` From 0c0991b6a14af3d40a721a13d2aa6699629cab21 Mon Sep 17 00:00:00 2001 From: Dawsh Date: Tue, 30 Jul 2024 11:37:08 +0330 Subject: [PATCH 4/5] rename how to guide directory --- content/docs/how-to-guide/_index.md | 6 ------ content/docs/how-to-guides/_index.md | 6 ++++++ content/docs/{how-to-guide => how-to-guides}/backup.md | 0 .../{how-to-guide => how-to-guides}/docker-deployment.md | 0 .../docs/{how-to-guide => how-to-guides}/generating-ssl.md | 0 .../subscription-settings.md | 0 content/docs/{how-to-guide => how-to-guides}/webhook.md | 0 7 files changed, 6 insertions(+), 6 deletions(-) delete mode 100644 content/docs/how-to-guide/_index.md create mode 100644 content/docs/how-to-guides/_index.md rename content/docs/{how-to-guide => how-to-guides}/backup.md (100%) rename content/docs/{how-to-guide => how-to-guides}/docker-deployment.md (100%) rename content/docs/{how-to-guide => how-to-guides}/generating-ssl.md (100%) rename content/docs/{how-to-guide => how-to-guides}/subscription-settings.md (100%) rename content/docs/{how-to-guide => how-to-guides}/webhook.md (100%) diff --git a/content/docs/how-to-guide/_index.md b/content/docs/how-to-guide/_index.md deleted file mode 100644 index 48d3b2e..0000000 --- a/content/docs/how-to-guide/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: How to Guides -next: ---- - -How to guides for marzneshin diff --git a/content/docs/how-to-guides/_index.md b/content/docs/how-to-guides/_index.md new file mode 100644 index 0000000..48ba7f8 --- /dev/null +++ b/content/docs/how-to-guides/_index.md @@ -0,0 +1,6 @@ +--- +title: How-to Guides +next: +--- + +How-to guides for marzneshin diff --git a/content/docs/how-to-guide/backup.md b/content/docs/how-to-guides/backup.md similarity index 100% rename from content/docs/how-to-guide/backup.md rename to content/docs/how-to-guides/backup.md diff --git a/content/docs/how-to-guide/docker-deployment.md b/content/docs/how-to-guides/docker-deployment.md similarity index 100% rename from content/docs/how-to-guide/docker-deployment.md rename to content/docs/how-to-guides/docker-deployment.md diff --git a/content/docs/how-to-guide/generating-ssl.md b/content/docs/how-to-guides/generating-ssl.md similarity index 100% rename from content/docs/how-to-guide/generating-ssl.md rename to content/docs/how-to-guides/generating-ssl.md diff --git a/content/docs/how-to-guide/subscription-settings.md b/content/docs/how-to-guides/subscription-settings.md similarity index 100% rename from content/docs/how-to-guide/subscription-settings.md rename to content/docs/how-to-guides/subscription-settings.md diff --git a/content/docs/how-to-guide/webhook.md b/content/docs/how-to-guides/webhook.md similarity index 100% rename from content/docs/how-to-guide/webhook.md rename to content/docs/how-to-guides/webhook.md From 73d1d47c63d05dbb48ff31515e283341b545bd09 Mon Sep 17 00:00:00 2001 From: Dawsh Date: Tue, 30 Jul 2024 11:50:48 +0330 Subject: [PATCH 5/5] rename some other files and titles --- content/docs/admins-guide/admin-management.md | 4 ++++ content/docs/admins-guide/admins-management.md | 4 ---- ...nd-hosts-management.md => inbound-and-host-management.md} | 2 +- content/docs/admins-guide/node-management.md | 5 +++++ content/docs/admins-guide/nodes-management.md | 5 ----- content/docs/admins-guide/service-management.md | 5 +++++ content/docs/admins-guide/services-management.md | 5 ----- .../admins-guide/{users-management.md => user-management.md} | 0 content/docs/getting-started/installation/_index.md | 4 ++++ .../{installations => installation}/marzneshin.md | 0 .../{installations => installation}/marznode.md | 0 content/docs/getting-started/installations/_index.md | 4 ---- 12 files changed, 19 insertions(+), 19 deletions(-) create mode 100644 content/docs/admins-guide/admin-management.md delete mode 100644 content/docs/admins-guide/admins-management.md rename content/docs/admins-guide/{inbounds-and-hosts-management.md => inbound-and-host-management.md} (53%) create mode 100644 content/docs/admins-guide/node-management.md delete mode 100644 content/docs/admins-guide/nodes-management.md create mode 100644 content/docs/admins-guide/service-management.md delete mode 100644 content/docs/admins-guide/services-management.md rename content/docs/admins-guide/{users-management.md => user-management.md} (100%) create mode 100644 content/docs/getting-started/installation/_index.md rename content/docs/getting-started/{installations => installation}/marzneshin.md (100%) rename content/docs/getting-started/{installations => installation}/marznode.md (100%) delete mode 100644 content/docs/getting-started/installations/_index.md diff --git a/content/docs/admins-guide/admin-management.md b/content/docs/admins-guide/admin-management.md new file mode 100644 index 0000000..caa58a3 --- /dev/null +++ b/content/docs/admins-guide/admin-management.md @@ -0,0 +1,4 @@ +--- +title: Admin Management +weight: 5 +--- diff --git a/content/docs/admins-guide/admins-management.md b/content/docs/admins-guide/admins-management.md deleted file mode 100644 index 2ab3e40..0000000 --- a/content/docs/admins-guide/admins-management.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Admins Management -weight: 5 ---- diff --git a/content/docs/admins-guide/inbounds-and-hosts-management.md b/content/docs/admins-guide/inbound-and-host-management.md similarity index 53% rename from content/docs/admins-guide/inbounds-and-hosts-management.md rename to content/docs/admins-guide/inbound-and-host-management.md index f20117f..95873fb 100644 --- a/content/docs/admins-guide/inbounds-and-hosts-management.md +++ b/content/docs/admins-guide/inbound-and-host-management.md @@ -1,5 +1,5 @@ --- -title: Inbounds & Hosts Management +title: Inbound & Host Management next: admin-management weight: 4 --- diff --git a/content/docs/admins-guide/node-management.md b/content/docs/admins-guide/node-management.md new file mode 100644 index 0000000..f638f0d --- /dev/null +++ b/content/docs/admins-guide/node-management.md @@ -0,0 +1,5 @@ +--- +title: Node Management +next: inbound-and-hosts-management +weight: 3 +--- diff --git a/content/docs/admins-guide/nodes-management.md b/content/docs/admins-guide/nodes-management.md deleted file mode 100644 index 49ac819..0000000 --- a/content/docs/admins-guide/nodes-management.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Nodes Management -next: inbounds-and-hosts-management -weight: 3 ---- diff --git a/content/docs/admins-guide/service-management.md b/content/docs/admins-guide/service-management.md new file mode 100644 index 0000000..4aadee8 --- /dev/null +++ b/content/docs/admins-guide/service-management.md @@ -0,0 +1,5 @@ +--- +title: Service Management +next: node-management +weight: 2 +--- diff --git a/content/docs/admins-guide/services-management.md b/content/docs/admins-guide/services-management.md deleted file mode 100644 index 96c3963..0000000 --- a/content/docs/admins-guide/services-management.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Services Management -next: nodes-management -weight: 2 ---- diff --git a/content/docs/admins-guide/users-management.md b/content/docs/admins-guide/user-management.md similarity index 100% rename from content/docs/admins-guide/users-management.md rename to content/docs/admins-guide/user-management.md diff --git a/content/docs/getting-started/installation/_index.md b/content/docs/getting-started/installation/_index.md new file mode 100644 index 0000000..99f8d63 --- /dev/null +++ b/content/docs/getting-started/installation/_index.md @@ -0,0 +1,4 @@ +--- +title: Installation +weight: 2 +--- diff --git a/content/docs/getting-started/installations/marzneshin.md b/content/docs/getting-started/installation/marzneshin.md similarity index 100% rename from content/docs/getting-started/installations/marzneshin.md rename to content/docs/getting-started/installation/marzneshin.md diff --git a/content/docs/getting-started/installations/marznode.md b/content/docs/getting-started/installation/marznode.md similarity index 100% rename from content/docs/getting-started/installations/marznode.md rename to content/docs/getting-started/installation/marznode.md diff --git a/content/docs/getting-started/installations/_index.md b/content/docs/getting-started/installations/_index.md deleted file mode 100644 index 1b96531..0000000 --- a/content/docs/getting-started/installations/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Installations -weight: 2 ----