mirror of
https://github.com/ParisNeo/ollama_proxy_server.git
synced 2025-09-06 05:12:14 +00:00
Update README.md
This commit is contained in:
22
README.md
22
README.md
@@ -1,4 +1,4 @@
|
||||
## Ollama Proxy Server
|
||||
# Ollama Proxy Server
|
||||
|
||||
[](LICENSE)
|
||||
[](https://www.python.org/downloads/release/python-311/)
|
||||
@@ -24,7 +24,7 @@ Ollama Proxy Server is a lightweight, secure proxy server designed to add a secu
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
```plaintext
|
||||
ollama_proxy_server/
|
||||
|- add_user.py # Script to add users to the authorized list
|
||||
|- authorized_users.txt.example # Example authorized users file
|
||||
@@ -97,7 +97,7 @@ curl localhost:8080 -H "Authorization: Bearer user1:0XAXAXAQX5A1F"
|
||||
|
||||
## Configuration
|
||||
|
||||
1. **`config.ini`**
|
||||
### `config.ini`
|
||||
|
||||
Copy `config.ini.example` to `config.ini` and edit it:
|
||||
|
||||
@@ -112,11 +112,11 @@ curl localhost:8080 -H "Authorization: Bearer user1:0XAXAXAQX5A1F"
|
||||
|
||||
* `url`: The URL of an Ollama backend server.
|
||||
|
||||
2. **`authorized_users.txt`**
|
||||
### `authorized_users.txt`
|
||||
|
||||
Copy `authorized_users.txt.example` to `authorized_users.txt` and edit it:
|
||||
|
||||
```
|
||||
```plaintext
|
||||
user:key
|
||||
another_user:another_key
|
||||
```
|
||||
@@ -137,14 +137,20 @@ Use the `add_user.py` script to add new users.
|
||||
python add_user.py <username> <key>
|
||||
```
|
||||
|
||||
Alternatively, you can use the newly created `ops` command:
|
||||
|
||||
```bash
|
||||
sudo ops add_user username:password
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please follow these steps:
|
||||
|
||||
1. Fork the repository.
|
||||
2. Create a feature branch (git checkout -b feature/your-feature).
|
||||
3. Commit your changes (git commit -am 'Add your feature').
|
||||
4. Push to the branch (git push origin feature/your-feature).
|
||||
2. Create a feature branch (`git checkout -b feature/your-feature`).
|
||||
3. Commit your changes (`git commit -am 'Add your feature'`).
|
||||
4. Push to the branch (`git push origin feature/your-feature`).
|
||||
5. Open a Pull Request.
|
||||
|
||||
See `CONTRIBUTING.md` for more details (to be added).
|
||||
|
Reference in New Issue
Block a user