README.md 1.7 KB
Retro AIM Server
Retro AIM Server is a server implementation of the OSCAR protocol that supports AIM versions 5.0-5.9.
This project is currently under heavy development. Retro AIM Server supports/will support the following features:
- Instant Messaging
- Buddy List
- Warning
- Away Messages
- User Profiles
- Chat Rooms
- Visibility Toggle
- User Blocking
- Buddy Icons
- User Directory
How to run
Retro AIM Server requires go 1.21.
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 at login and skip the password check. Useful for development purposes. |
DB_PATH |
The path to the SQLite database. |
LOG_LEVEL |
Set logging granularity. Possible values: trace, debug, info, warn, error |
Starting Up
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 http://localhost:8080/user
Create Users
curl -d'{"screen_name":"myScreenName", "password":"thepassword"}' http://localhost:8080/user