From d93c0c6c4e4c91f768093612eba188156beecc56 Mon Sep 17 00:00:00 2001 From: Mardin <54506351+Krr0ptioN@users.noreply.github.com> Date: Tue, 13 Aug 2024 00:17:34 +0300 Subject: [PATCH] chore: changing from khodedawsh to marzneshin (#7) --- content/docs/contribution-guideline/_index.md | 2 +- .../advanced-install/marzneshin.md | 12 +++---- .../advanced-install/marznode.md | 9 +++-- content/docs/getting-started/basic-install.md | 36 ++++++++++--------- hugo.yaml | 2 +- 5 files changed, 32 insertions(+), 29 deletions(-) diff --git a/content/docs/contribution-guideline/_index.md b/content/docs/contribution-guideline/_index.md index 2761f4d..4ab77e0 100644 --- a/content/docs/contribution-guideline/_index.md +++ b/content/docs/contribution-guideline/_index.md @@ -20,7 +20,7 @@ Include the following information in your post: Please refrain from opening issues solely to **ask a question**. Instead, use one of the following methods: - Ask in our Telegram group: [@marzneshins](https://t.me/marzneshins) -- Use our [GitHub Discussions](https://github.com/khodedawsh/marzneshin/discussions) long-term discussions or more complex questions. +- Use our [GitHub Discussions](https://github.com/marzneshin/marzneshin/discussions) long-term discussions or more complex questions. {{< /callout >}} diff --git a/content/docs/getting-started/advanced-install/marzneshin.md b/content/docs/getting-started/advanced-install/marzneshin.md index 94259c0..3cfa6a6 100644 --- a/content/docs/getting-started/advanced-install/marzneshin.md +++ b/content/docs/getting-started/advanced-install/marzneshin.md @@ -2,6 +2,7 @@ title: Marzneshin weight: 1 --- + If you are eager to run the project using the source code, check the section below ## Manual install (advanced) @@ -13,7 +14,7 @@ If you are eager to run the project using the source code, check the section bel Clone this project and install the dependencies (you'd need Python >= 3.10) ```bash -git clone https://github.com/khodedawsh/Marzneshin +git clone https://github.com/marzneshin/Marzneshin cd Marzneshin/ wget -qO- https://bootstrap.pypa.io/get-pip.py | python3 - python3 -m pip install -r requirements.txt @@ -21,7 +22,6 @@ python3 -m pip install -r requirements.txt Alternatively, to run in an isolated environment you can create a [virtual environment](https://pypi.org/project/virtualenv/) - ### Build the dashboard To install dashboard dependencies and build the dashboard: @@ -60,6 +60,7 @@ nano .env ### Generate the database Currently to generate the db, you should run + ```bash alembic upgrade head ``` @@ -68,10 +69,9 @@ alembic upgrade head Eventually, launch the application using one of the below commands - -| Using systemd (recommended) | Using make (one-time) | -| :---------------------------------- | ------------------------------------- | -| ```bash tools/service-install.sh```
```systemctl enable --now marzneshin``` | ```make start``` | +| Using systemd (recommended) | Using make (one-time) | +| :--------------------------------------------------------------------- | --------------------- | +| `bash tools/service-install.sh`
`systemctl enable --now marzneshin` | `make start` | By default the app will be run on `http://localhost:8000/dashboard`. You can configure it using changing the `UVICORN_HOST` and `UVICORN_PORT` environment variables. diff --git a/content/docs/getting-started/advanced-install/marznode.md b/content/docs/getting-started/advanced-install/marznode.md index dc5a9ef..324c88a 100644 --- a/content/docs/getting-started/advanced-install/marznode.md +++ b/content/docs/getting-started/advanced-install/marznode.md @@ -19,10 +19,10 @@ curl -fsSL https://get.docker.com | sh {{% steps %}} - ### Setup your certificate Create the necessary directory + ```sh mkdir -p /var/lib/marznode/ ``` @@ -31,14 +31,13 @@ And get your certificate from marzneshin settings, place it here: `/var/lib/marznode/client.pem` - ### Setup some xray config 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: +We setup the sample config from marznode repository in this case: ```sh -curl -L https://github.com/khodedawsh/marznode/raw/master/xray_config.json > /var/lib/marznode/xray_config.json +curl -L https://github.com/marzneshin/marznode/raw/master/xray_config.json > /var/lib/marznode/xray_config.json ``` ### Get Marznode @@ -46,7 +45,7 @@ curl -L https://github.com/khodedawsh/marznode/raw/master/xray_config.json > /va To clone marznode ```sh -git clone https://github.com/khodedawsh/marznode +git clone https://github.com/marzneshin/marznode cd marznode ``` diff --git a/content/docs/getting-started/basic-install.md b/content/docs/getting-started/basic-install.md index ff0e4fc..585b9f3 100644 --- a/content/docs/getting-started/basic-install.md +++ b/content/docs/getting-started/basic-install.md @@ -6,28 +6,32 @@ weight: 1 To get started, you just need a linux machine. {{< callout type="info" >}} - TLDR for installation: - - ```bash - sudo bash -c "$(curl -sL https://github.com/khodedawsh/Marzneshin/raw/master/script.sh)" @ install - ``` - After that make sure you create an admin: - ```bash - marzneshin cli admin create --sudo - ``` +TLDR for installation: + +```bash +sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install +``` + +After that make sure you create an admin: + +```bash +marzneshin cli admin create --sudo +``` + {{< /callout >}} Marzneshin currently supports the following databases. SQLite is preferred for small setups, while MariaDB is recommended for larger configurations. {{< tabs items="mariadb,mysql,sqlite" >}} +{{< tab >}}```bash +sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install --database mariadb + +````{{< /tab >}} {{< tab >}}```bash -sudo bash -c "$(curl -sL https://github.com/khodedawsh/Marzneshin/raw/master/script.sh)" @ install --database mariadb -```{{< /tab >}} - {{< tab >}}```bash -sudo bash -c "$(curl -sL https://github.com/khodedawsh/Marzneshin/raw/master/script.sh)" @ install --database mysql +sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install --database mysql ```{{< /tab >}} {{< tab >}}```bash -sudo bash -c "$(curl -sL https://github.com/khodedawsh/Marzneshin/raw/master/script.sh)" @ install +sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install ```{{< /tab >}} {{< /tabs >}} @@ -48,7 +52,7 @@ Next, you need to create a sudo admin for logging into the Marzneshin dashboard ```bash marzneshin cli admin create --sudo -``` +```` That's it! You can login to your dashboard using these credentials @@ -60,4 +64,4 @@ marzneshin --help ### Configuring TLS -Refer to [running behind nginx](/docs/how-to-guides/behind-nginx) \ No newline at end of file +Refer to [running behind nginx](/docs/how-to-guides/behind-nginx) diff --git a/hugo.yaml b/hugo.yaml index a99a087..1d14850 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -37,7 +37,7 @@ menu: - identifier: github name: GitHub weight: 5 - url: "https://github.com/khodedawsh/marzneshin" + url: "https://github.com/marzneshin/marzneshin" params: icon: github