Skip to content

Commit a019157

Browse files
fix readme for lint
1 parent 2b715c7 commit a019157

File tree

1 file changed

+35
-13
lines changed

1 file changed

+35
-13
lines changed

README.md

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Ollama Token API
22

3-
The **ollama-token-api** project aims to add bearer authentication to Ollama, allowing users to secure their access without needing different client libraries. It works by validating tokens stored in a MongoDB database and reverse proxying requests to the Ollama server using Hono.
3+
The **ollama-token-api** project aims to add bearer authentication to Ollama,
4+
allowing users to secure their access without needing different client
5+
libraries. It works by validating tokens stored in a MongoDB database and
6+
reverse proxying requests to the Ollama server using Hono.
47

58
## Table of Contents
9+
610
- [Features](#features)
711
- [Installation](#installation)
812
- [Using Docker (Recommended)](#using-docker-recommended)
@@ -13,59 +17,77 @@ The **ollama-token-api** project aims to add bearer authentication to Ollama, al
1317

1418
## Features
1519

16-
- **Bearer Authorization:** Implement OAuth2 bearer token authentication for Ollama.
20+
- **Bearer Authorization:** Implement OAuth2 bearer token authentication for
21+
Ollama.
1722
- **MongoDB Token Storage:** Store and retrieve tokens from a MongoDB database.
18-
- **Honol Reverse Proxying:** Use Hono to reverse proxy requests to the Ollama server.
19-
- **Highly Customizable:** Configurable via environmental variables or configuration files.
23+
- **Honol Reverse Proxying:** Use Hono to reverse proxy requests to the Ollama
24+
server.
25+
- **Highly Customizable:** Configurable via environmental variables or
26+
configuration files.
2027

2128
## Installation
2229

2330
### Using Docker (Recommended)
2431

25-
You can deploy this API using Docker. The official Docker image is available on both GitHub and our private registry.
32+
You can deploy this API using Docker. The official Docker image is available on
33+
both GitHub and our private registry.
2634

2735
#### Pulling Docker Image from Public Registry
36+
2837
```sh
2938
docker pull ghcr.io/clowdertech/ollama-token-api:latest
3039
```
3140

3241
Or, for a specific tag:
42+
3343
```sh
3444
docker pull ghcr.io/clowdertech/ollama-token-api:<tag>
3545
```
3646

3747
#### Pulling Docker Image from Private Forgejo Registry
3848

39-
If you aim to contribute or access the latest development builds, use our dedicated registry.
49+
If you aim to contribute or access the latest development builds, use our
50+
dedicated registry.
4051

4152
```sh
4253
docker pull forgejo.clowdertech.com/clowdertech/ollama-token-api:master
4354
```
4455

4556
### Manual Installation
4657

47-
TODO: Add detailed installation instructions for manual setup (including setting up MongoDB and Hono).
58+
TODO: Add detailed installation instructions for manual setup (including setting
59+
up MongoDB and Hono).
4860

4961
## Usage
5062

51-
Once installed, start using Ollama Token API by sending requests with appropriately authenticated bearer tokens.
63+
Once installed, start using Ollama Token API by sending requests with
64+
appropriately authenticated bearer tokens.
65+
66+
For additional configuration options or advanced usage, please refer to the
67+
following file:
5268

53-
For additional configuration options or advanced usage, please refer to the following file:
5469
- [docs/configuration.md](docs/configuration.md)
5570

5671
## Contributing
57-
Contributions are highly welcomed! If you wish to contribute to this project, please follow these steps:
5872

59-
1. Fork this repository using Forgejo (https://forgejo.clowdertech.com/clowdertech/ollama-token-api).
73+
Contributions are highly welcomed! If you wish to contribute to this project,
74+
please follow these steps:
75+
76+
1. Fork this repository using Forgejo
77+
(https://forgejo.clowdertech.com/clowdertech/ollama-token-api).
6078
2. Create a new feature branch from `master`.
6179
3. Commit your changes following standard conventions.
6280
4. Push the branch to your fork and create a Pull Request.
6381

6482
For more details on contribution guidelines, see:
83+
6584
- [CONTRIBUTING.md](CONTRIBUTING.md)
6685

6786
## License
68-
This project is licensed under the terms of the **Apache License**. See LICENSE file for full details.
87+
88+
This project is licensed under the terms of the **Apache License**. See LICENSE
89+
file for full details.
6990

7091
---
71-
*Built with ❤️ by ClowderTech*
92+
93+
_Built with ❤️ by ClowderTech_

0 commit comments

Comments
 (0)