diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 7387244e..00000000 --- a/README.en.md +++ /dev/null @@ -1,95 +0,0 @@ -
- 中文 | English -
- - - -- Download - · - Tutorial - · - Feedback - · - Demo -
- -## Features -+ [x] Built-in user management. -+ [x] Built-in file management. -+ [x] [GitHub OAuth](https://github.com/settings/applications/new). -+ [x] WeChat official account authorization (need [wechat-server](https://github.com/songquanpeng/wechat-server)). -+ [x] Email verification & password reset. -+ [x] Request rate limiting. -+ [x] Static files caching. -+ [x] Mobile friendly UI. -+ [x] Token based authorization. -+ [x] Use GitHub Actions to build releases & Docker images. -+ [x] Cloudflare Turnstile user validation. - -## Deployment -### Manual deployment -1. Download built binary from [GitHub Releases](https://github.com/songquanpeng/one-api/releases/latest) or build from source: - ```shell - git clone https://github.com/songquanpeng/one-api.git - go mod download - go build -ldflags "-s -w" -o one-api - ```` -2. Run it: - ```shell - chmod u+x one-api - ./one-api --port 3000 --log-dir ./logs - ``` -3. Visit [http://localhost:3000/](http://localhost:3000/) and login. The username for the initial account is `root` and the password is `123456`. - -### Deploy with Docker -Execute: `docker run -d --restart always -p 3000:3000 -v /home/ubuntu/data/one-api:/data -v /etc/ssl/certs:/etc/ssl/certs:ro justsong/one-api` - -Data will be saved in `/home/ubuntu/data/one-api`. - -## Configurations -The system works out of the box. - -You can configure the system by set environment variables or specify command line arguments. - -After the system starts, use `root` user to log in to the system and do further configuration. - -### Environment Variables -1. `REDIS_CONN_STRING`: when set, Redis will be used as the storage for request rate limitation instead of memory storage. - + Example: `REDIS_CONN_STRING=redis://default:redispw@localhost:49153` -2. `SESSION_SECRET`: when set, a fixed session key will be used so that the logged-in users' cookie remains valid across system reboots. - + Example: `SESSION_SECRET=random_string` -3. `SQL_DSN`: when set, the target SQL database will be used instead of SQLite. - + Example: `SQL_DSN=root:123456@tcp(localhost:3306)/one-api` - -### Command line Arguments -1. `--port- 中文 | English -
-