Skip to content

Commit 5169455

Browse files
committed
Add installation guide for readme
1 parent dc88828 commit 5169455

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,86 @@ The DB can be used without the AI proxy for more fine grained control of the gen
5858

5959
2. The CLI comes packaged into the docker images.
6060

61+
---
62+
63+
### Installation
64+
65+
#### Download Binaries
66+
67+
You can download the Ahnlich binaries for `ai` and `db` from [GitHub Releases](https://github.com/deven96/ahnlich/releases).
68+
69+
- **`wget`:**
70+
```bash
71+
wget https://github.com/deven96/ahnlich/releases/download/bin%2Fdb%2F0.0.0/aarch64-darwin-ahnlich-db.tar.gz
72+
```
73+
74+
- **Extract the file:**
75+
```bash
76+
tar -xvzf aarch64-darwin-ahnlich-db.tar.gz
77+
```
78+
79+
- **Run the binary:**
80+
```bash
81+
./ahnlich-db
82+
```
83+
84+
Replace `aarch64-darwin-ahnlich-db.tar.gz` with the appropriate file name for your architecture. For `ai`, download the corresponding `ai` binary, extract it, and run it using `./ahnlich-ai`.
85+
86+
---
87+
88+
#### Using Docker
89+
90+
You can pull the prebuilt Docker images for Ahnlich:
91+
92+
- **Ahnlich AI**:
93+
```bash
94+
docker pull ghcr.io/deven96/ahnlich-ai:latest
95+
```
96+
97+
- **Ahnlich DB**:
98+
```bash
99+
docker pull ghcr.io/deven96/ahnlich-db:latest
100+
```
101+
102+
---
103+
104+
#### Example Docker Compose
105+
106+
Below is an example `docker-compose.yaml` configuration to run both `ahnlich-db` and `ahnlich-ai`:
107+
108+
```yaml
109+
services:
110+
ahnlich_db:
111+
image: ghcr.io/deven96/ahnlich-db:latest
112+
command: "ahnlich-db run --host 0.0.0.0 --enable-tracing"
113+
ports:
114+
- "1369:1369"
115+
116+
ahnlich_ai:
117+
image: ghcr.io/deven96/ahnlich-ai:latest
118+
command: "ahnlich-ai run --db-host ahnlich_db --host 0.0.0.0 --port 8880 --enable-tracing --supported-models all-minilm-l6-v2,resnet-50"
119+
ports:
120+
- "1370:1370"
121+
```
122+
123+
---
124+
125+
#### Environment Variables
126+
127+
The following environment variable can also be set:
128+
129+
- `DEMO_OTEL_URL`: Set the OpenTelemetry endpoint. Example:
130+
131+
```bash
132+
DEMO_OTEL_URL=http://<otel-endpoint>
133+
```
134+
135+
You can pass this variable directly to your Docker containers using `environment` in your Docker Compose file or when running `docker run`.
136+
137+
---
138+
139+
140+
61141
### Contributing
62142

63143
View [contribution guide](CONTRIBUTING.md)

0 commit comments

Comments
 (0)