generated from imfing/hextra-starter-template
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add description for xray & sing-box, also drop empty stuff
- Loading branch information
1 parent
2e83f2b
commit 38085c5
Showing
14 changed files
with
101 additions
and
58 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: hysteria 2 | ||
weight: 3 | ||
--- | ||
|
||
[Hysteria 2](https://github.com/apernet/hysteria/) is a mono-protocol backend supported by marznode. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
--- | ||
title: sing-box | ||
weight: 2 | ||
--- | ||
|
||
[Sing-box](https://sing-box.sagernet.org/) is yet another backend supported by marznode. | ||
|
||
Currently supported protocols include: | ||
- VMess | ||
- VLESS | ||
- Trojan | ||
- Shadowsocks | ||
- Hysteria2 | ||
- TUIC | ||
|
||
|
||
## Configuration settings on marznode | ||
The following environmental variables are used to utilize and configure sing-box on marznode: | ||
- `SING_BOX_ENABLED` `True`/`False` | ||
- `SING_BOX_EXECUTABLE_PATH` Path to the sing-box binary. The binary should include `with_v2ray_api` tag. | ||
- `SING_BOX_CONFIG_PATH` Path to sing-box config. | ||
- `SING_BOX_RESTART_ON_FAILURE` Whether to restart in case of crash/exit. `True`/`False` | ||
- `SING_BOX_RESTART_ON_FAILURE_INTERVAL` Interval between restarts in case of crash. | ||
|
||
## Example, using the marznode docker image | ||
Sing-box is included by default in [marznode docker image](https://hub.docker.com/r/dawsh/marznode), with the binary placed in `/usr/local/bin/sing-box`. | ||
|
||
A fine compose.yml looks like this: | ||
|
||
```yaml | ||
services: | ||
marznode: | ||
image: dawsh/marznode:latest | ||
restart: always | ||
network_mode: host | ||
command: [ "sh", "-c", "sleep 10 && python3 marznode.py" ] | ||
|
||
environment: | ||
XRAY_EXECUTABLE_PATH: "/usr/local/bin/xray" | ||
XRAY_ASSETS_PATH: "/usr/local/lib/xray" | ||
XRAY_CONFIG_PATH: "/var/lib/marznode/xray_config.json" | ||
|
||
# The following variables tell marznode to run sing-box: | ||
SING_BOX_ENABLED: "True" | ||
SING_BOX_EXECUTABLE_PATH: "/usr/local/bin/sing-box" | ||
SING_BOX_CONFIG_PATH: "/var/lib/marznode/sing-box.json" | ||
|
||
HYSTERIA_EXECUTABLE_PATH: "/usr/local/bin/hysteria" | ||
SSL_CLIENT_CERT_FILE: "/var/lib/marznode/client.pem" | ||
SSL_KEY_FILE: "./server.key" | ||
SSL_CERT_FILE: "./server.cert" | ||
|
||
volumes: | ||
- /var/lib/marznode:/var/lib/marznode | ||
``` | ||
Make sure `/var/lib/marznode/sing-box.json` exists, and is a valid sing-box config. | ||
|
||
## See also | ||
- [configuration documents](https://sing-box.sagernet.org/configuration/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: Xray-core | ||
weight: 1 | ||
--- | ||
|
||
|
||
[Xray-core](https://github.com/xtls/xray-core) is a backend supported by marznode. Xray is enabled by default on marznode. | ||
|
||
|
||
Currently supported protocols include: | ||
- VMess | ||
- VLESS | ||
- Trojan | ||
- Shadowsocks | ||
|
||
|
||
## Configuration settings on marznode | ||
The following environmental variables are used to utilize and configure Xray on marznode: | ||
- `XRAY_ENABLED` `True`/`False` | ||
- `XRAY_EXECUTABLE_PATH` Path to the xray binary. | ||
- `XRAY_CONFIG_PATH` Path to xray config. | ||
- `XRAY_RESTART_ON_FAILURE` Whether to restart in case of crash/exit. `True`/`False` | ||
- `XRAY_RESTART_ON_FAILURE_INTERVAL` Interval between restarts in case of crash. | ||
|
||
## See also | ||
- [configuration documents](https://xtls.github.io/config/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.