mirror of
https://github.com/router-for-me/CLIProxyAPI.git
synced 2026-02-03 04:50:52 +08:00
Update README
This commit is contained in:
40
README.md
40
README.md
@@ -497,26 +497,38 @@ docker run --rm -p 8317:8317 -v /path/to/your/config.yaml:/CLIProxyAPI/config.ya
|
||||
|
||||
## Run with Docker Compose
|
||||
|
||||
1. Clone the repository:
|
||||
1. Clone the repository and navigate into the directory:
|
||||
```bash
|
||||
git clone https://github.com/luispater/CLIProxyAPI.git
|
||||
cd CLIProxyAPI
|
||||
```
|
||||
|
||||
2. Create a `config.yaml` from `config.example.yaml` and customize it.
|
||||
2. Prepare the configuration file:
|
||||
Create a `config.yaml` file by copying the example and customize it to your needs.
|
||||
```bash
|
||||
cp config.example.yaml config.yaml
|
||||
```
|
||||
*(Note for Windows users: You can use `copy config.example.yaml config.yaml` in CMD or PowerShell.)*
|
||||
|
||||
3. Run the interactive script to start the service:
|
||||
- For Windows (PowerShell):
|
||||
```powershell
|
||||
.\docker-build.ps1
|
||||
```
|
||||
- For Linux/macOS:
|
||||
```bash
|
||||
bash docker-build.sh
|
||||
```
|
||||
The script will prompt you to choose how to run the application:
|
||||
- **Option 1: Run using Pre-built Image (Recommended)**: Pulls the latest official image from the registry and starts the container. This is the easiest way to get started.
|
||||
- **Option 2: Build from Source and Run (For Developers)**: Builds the image from the local source code, tags it as `cli-proxy-api:local`, and then starts the container. This is useful if you are making changes to the source code.
|
||||
3. Start the service:
|
||||
- **For most users (recommended):**
|
||||
Run the following command to start the service using the pre-built image from Docker Hub. The service will run in the background.
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
- **For advanced users:**
|
||||
If you have modified the source code and need to build a new image, use the interactive helper scripts:
|
||||
- For Windows (PowerShell):
|
||||
```powershell
|
||||
.\docker-build.ps1
|
||||
```
|
||||
- For Linux/macOS:
|
||||
```bash
|
||||
bash docker-build.sh
|
||||
```
|
||||
The script will prompt you to choose how to run the application:
|
||||
- **Option 1: Run using Pre-built Image (Recommended)**: Pulls the latest official image from the registry and starts the container. This is the easiest way to get started.
|
||||
- **Option 2: Build from Source and Run (For Developers)**: Builds the image from the local source code, tags it as `cli-proxy-api:local`, and then starts the container. This is useful if you are making changes to the source code.
|
||||
|
||||
4. To authenticate with providers, run the login command inside the container:
|
||||
- **Gemini**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login`
|
||||
|
||||
Reference in New Issue
Block a user