update docs

This commit is contained in:
Benson Wong
2024-10-04 21:11:08 -07:00
parent cc944251df
commit 4fae7cf946
4 changed files with 13 additions and 5 deletions

3
.gitignore vendored
View File

@@ -1,3 +1,4 @@
.aider* .aider*
.env .env
build/ build/
dist/

View File

@@ -38,7 +38,7 @@ models:
proxy: "http://127.0.0.1:8999" proxy: "http://127.0.0.1:8999"
``` ```
## Deployment ## Installation
1. Create a configuration file, see [config.example.yaml](config.example.yaml) 1. Create a configuration file, see [config.example.yaml](config.example.yaml)
1. Download a [release](https://github.com/mostlygeek/llama-swap/releases) appropriate for your OS and architecture. 1. Download a [release](https://github.com/mostlygeek/llama-swap/releases) appropriate for your OS and architecture.
@@ -47,7 +47,7 @@ models:
## Systemd Unit Files ## Systemd Unit Files
Use this unit file to start llama-swap on boot Use this unit file to start llama-swap on boot. This is only tested on Ubuntu.
`/etc/systemd/system/llama-swap.service` `/etc/systemd/system/llama-swap.service`
``` ```
@@ -68,4 +68,10 @@ StartLimitInterval=30
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
``` ```
## Building from Source
1. Install golang for your system
1. run `make clean all`
1. binaries will be built into `build/` directory

2
go.mod
View File

@@ -2,4 +2,4 @@ module github.com/mostlygeek/llama-swap
go 1.23.0 go 1.23.0
require gopkg.in/yaml.v3 v3.0.1 // indirect require gopkg.in/yaml.v3 v3.0.1

1
go.sum
View File

@@ -1,3 +1,4 @@
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=