Skip to content

Commit

Permalink
Add install
Browse files Browse the repository at this point in the history
  • Loading branch information
crackair committed Apr 6, 2021
1 parent f6659e0 commit d42d254
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_book/*
7 changes: 6 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Table of contents
# Summary

* [关于XrayR](README.md)

## XrayR下载和安装
* [使用一键脚本安装](install/one-click/README.md)
* [使用docker安装](install/docker/README.md)
* [手动安装](install/manual/README.md)

55 changes: 55 additions & 0 deletions install/docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# 使用Docker安装

## 安装 Docker

### Centos
```bash
yum install -y yum-utils
yum-config-manager \
--add-repo \
https://download.docker.com/linux/centos/docker-ce.repo
yum install docker-ce docker-ce-cli containerd.io -y
systemctl start docker
systemctl enable docker
```
### Debian / Ubuntu
```bash
sudo apt-get update
sudo apt-get install \
apt-transport-https \
ca-certificates \
curl \
gnupg-agent \
software-properties-common -y
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"
sudo apt-get install docker-ce docker-ce-cli containerd.io -y
systemctl start docker
systemctl enable docker
```
## 安装Docker-compose
```bash
curl -fsSL https://get.docker.com | bash -s docker
curl -L "https://github.com/docker/compose/releases/download/1.26.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
```

## 安装XrayR

1. `git clone https://github.com/XrayR-project/XrayR-release`
2. `cd XrayR-release`
3. 编辑配置文件:`config.yml`
4. 启动docker:`docker-compose up -d`

## 更新XrayR

docker-compose仅需两条简单通用的命令即可实现更新、删除容器并重启。更新软件后`config.yml`不会被更新覆盖。

注意在 docker-compose.yml 所在的目录下执行:
```bash
docker-compose pull
docker-compose up -d
```
16 changes: 16 additions & 0 deletions install/manual/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 手动安装

## 下载并使用
1. 在此处,根据自身系统选择合适的版本:[Release](https://github.com/XrayR-project/XrayR/releases)
2. 解压压缩包,之后运行:`./XrayR -config config.yml`

## 编译并使用
1. go 1.16.0
2. 依次运行
```bash
git clone https://github.com/XrayR-project/XrayR
cd XrayR/main
go mod tidy
go build -o XrayR -ldflags "-s -w"
./XrayR -config config.yml
```
14 changes: 14 additions & 0 deletions install/one-click/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 使用一键脚本安装

## 软件安装

```bash
bash <(curl -Ls https://raw.githubusercontent.com/XrayR-project/XrayR-release/master/install.sh)
```
配置文件路径:`/etc/XrayR`

## 软件更新

```bash
XrayR update
```

0 comments on commit d42d254

Please sign in to comment.