Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: changing from khodedawsh to marzneshin #7

Merged
merged 1 commit into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/contribution-guideline/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 >}}

Expand Down
12 changes: 6 additions & 6 deletions content/docs/getting-started/advanced-install/marzneshin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -13,15 +14,14 @@ 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
```

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:
Expand Down Expand Up @@ -60,6 +60,7 @@ nano .env
### Generate the database

Currently to generate the db, you should run

```bash
alembic upgrade head
```
Expand All @@ -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```<br>```systemctl enable --now marzneshin``` | ```make start``` |
| Using systemd (recommended) | Using make (one-time) |
| :--------------------------------------------------------------------- | --------------------- |
| `bash tools/service-install.sh`<br>`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.
Expand Down
9 changes: 4 additions & 5 deletions content/docs/getting-started/advanced-install/marznode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
```
Expand All @@ -31,22 +31,21 @@ 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

To clone marznode

```sh
git clone https://github.com/khodedawsh/marznode
git clone https://github.com/marzneshin/marznode
cd marznode
```

Expand Down
36 changes: 20 additions & 16 deletions content/docs/getting-started/basic-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 >}}
Expand All @@ -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

Expand All @@ -60,4 +64,4 @@ marzneshin --help

### Configuring TLS

Refer to [running behind nginx](/docs/how-to-guides/behind-nginx)
Refer to [running behind nginx](/docs/how-to-guides/behind-nginx)
2 changes: 1 addition & 1 deletion hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down