|
|
@@ -0,0 +1,42 @@
|
|
|
+# goaim
|
|
|
+
|
|
|
+goaim is an implemntation of the OSCAR protocol that supports AIM versions 5.0-5.9.
|
|
|
+
|
|
|
+## How to run
|
|
|
+
|
|
|
+goaim requires [go 1.21](https://go.dev/).
|
|
|
+
|
|
|
+### Configuration
|
|
|
+
|
|
|
+Server configuration is set through environment variables. The following are the most useful configs:
|
|
|
+
|
|
|
+| Env Variable | Description |
|
|
|
+| ------------ | ----------- |
|
|
|
+| OSCAR_HOST | The hostname that the server should bind to. If exposing to the internet, use the public IP. |
|
|
|
+| DISABLE_AUTH | If true, auto-create screen names and skip the password check. Useful for development purposes. |
|
|
|
+| DB_PATH | The path to the SQLite database.|
|
|
|
+
|
|
|
+### Starting Up
|
|
|
+
|
|
|
+```shell
|
|
|
+DISABLE_AUTH=true \
|
|
|
+OSCAR_HOST=192.168.64.1 \
|
|
|
+DB_PATH=./aim.db \
|
|
|
+go run ./cmd/main.go
|
|
|
+```
|
|
|
+
|
|
|
+### User Management
|
|
|
+
|
|
|
+User management is done through a REST API.
|
|
|
+
|
|
|
+#### List Users
|
|
|
+
|
|
|
+```curl
|
|
|
+curl http://localhost:8080/user
|
|
|
+```
|
|
|
+
|
|
|
+#### Create Users
|
|
|
+
|
|
|
+```curl
|
|
|
+curl -d'{"screen_name":"myScrenName", "password":"thepassword"}' http://localhost:8080/user
|
|
|
+```
|
Mike