Home Explore Help
Sign In
LBP
/
mk6i-open-oscar-server
mirror of https://github.com/mk6i/open-oscar-server.git
4
0
Fork 0
Files Issues 0 Wiki

No Description

Tree: b6306331cd
Branches Tags
mk6i-open-oscar...
ZIP TAR.GZ
Mike b6306331cd docs updates 2 years ago
.github d56443d126 feat: create template for feature requests (#22) 2 years ago
cmd c716ac3032 resolve confusion over which executable to run 2 years ago
config c716ac3032 resolve confusion over which executable to run 2 years ago
docs b6306331cd docs updates 2 years ago
foodgroup b1620417bd replace config.Address with net.JoinHostPort 2 years ago
scripts c716ac3032 resolve confusion over which executable to run 2 years ago
server 9a120cdedd log hostname at application startup 2 years ago
state a075fb540f clear up OService user flag and status constants 2 years ago
wire a075fb540f clear up OService user flag and status constants 2 years ago
.gitignore a1012eefad generate env files from Config struct tags 2 years ago
.goreleaser.yaml c716ac3032 resolve confusion over which executable to run 2 years ago
.mockery.yaml 11f5fd2582 issue #14 - implement SNAC 09,03 PD RightsQuery 2 years ago
Dockerfile.goreleaser 2d0f7a2716 obfuscate windows builds to avoid defender quarantine 2 years ago
LICENSE 84c6909f36 fix data race in bos_service and chat_service tests 2 years ago
Makefile c716ac3032 resolve confusion over which executable to run 2 years ago
README.md b6306331cd docs updates 2 years ago
api.yml e578066e18 implement PUT /user/password 2 years ago
codecov.yml 84c6909f36 fix data race in bos_service and chat_service tests 2 years ago
go.mod 041c5270b7 use sqlite3 driver for migrations 2 years ago
go.sum 041c5270b7 use sqlite3 driver for migrations 2 years ago

README.md

Retro AIM Server

[![codecov](https://codecov.io/gh/mk6i/retro-aim-server/graph/badge.svg?token=MATKPP77JT)](https://codecov.io/gh/mk6i/retro-aim-server) [![Discord](https://img.shields.io/discord/1238648671348719626?logo=discord&logoColor=white)](https://discord.gg/2Xy4nF3Uh9)

Retro AIM Server is an instant messaging server that revives AOL Instant Messenger clients from the 2000s.

screenshot of retro aim server running next to AIM

The following features are supported:

  • Windows AIM client v2.x, v3.x, v4.x, v5.x
  • Away Messages
  • Buddy Icons (v4.x, v5.x)
  • Buddy List
  • Chat Rooms (v4.x, v5.x)
  • Instant Messaging
  • User Profiles
  • Blocking (v3.5+)
  • Visibility Toggle / Idle Notification
  • Warning

🏁 How to Run

Get up and running with Retro AIM Server using one of these handy server quickstart guides:

Don't have AIM installed yet? Check out the AIM Client Setup Guide.

🛠️ Development

This project is under active development. Contributions are welcome!

Follow this guide to learn how to compile and run Retro AIM Server.

🌍 Community

Check out the Retro AIM Server Discord server to get help or find out how to get involved.

👤 Management API

The Management API provides functionality for administering the server (see OpenAPI spec). The following shows you how to run these commands via the command line.

Windows PowerShell

Run these commands from PowerShell, not Command Prompt.

List Users

Invoke-WebRequest -Uri http://localhost:8080/user -Method Get

Create Users

Invoke-WebRequest -Uri http://localhost:8080/user `
  -Body '{"screen_name":"myscreenname", "password":"thepassword"}' `
  -Method Post `
  -ContentType "application/json"

Change Password

Invoke-WebRequest -Uri http://localhost:8080/user/password `
  -Body '{"screen_name":"myscreenname", "password":"thenewpassword"}' `
  -Method Put `
  -ContentType "application/json"

List Active Sessions

This request lists sessions for all logged in users.

Invoke-WebRequest -Uri http://localhost:8080/session -Method Get

macOS / Linux

List Users

curl http://localhost:8080/user

Create Users

curl -d'{"screen_name":"myscreenname", "password":"thepassword"}' http://localhost:8080/user

Change Password

curl -X PUT -d'{"screen_name":"myscreenname", "password":"thenewpassword"}' http://localhost:8080/user/password

List Active Sessions

This request lists sessions for all logged in users.

curl http://localhost:8080/session

🔗 Acknowledgements

  • aim-oscar-server is another cool open source AIM server project.
  • NINA Wiki is an indispensable source for figuring out the OSCAR API.
  • libpurple is also an invaluable OSCAR reference (especially version 2.10.6-1).

📄 License

Retro AIM Server is licensed under the MIT license.