microlinkhq / unavatar

Get unified user avatar from social networks, including Instagram, SoundCloud, Telegram, Twitter, YouTube & more.
https://unavatar.io
MIT License
1.21k stars 70 forks source link

Documentation for self-hosting? #365

Open isaachinman opened 4 days ago

isaachinman commented 4 days ago

Hi there, just coming across this project. Although Avatar API seems fantastic, their pricing simply does not scale if your use case is bulk data processing.

unavatar seems more limited, but it's fantastic to see an OSS implementation.

That said, I was unable to find any documentation on self-hosting. I have looked through the Dockerfile, and might suggest that you publish builds to Dockerhub or another registry.

Kikobeats commented 4 days ago

Hello, The Dockerfile is not published into the registry because it's not doing nothing special, just exposing a Node.js server that will be used for receiving the traffic.

If publisth the Docker image will help you to adopt the project I can publish it, I did that before for exampel at https://github.com/Kikobeats/docker-vips, just tell me 🙂

isaachinman commented 4 days ago

it's not doing nothing special, just exposing a Node.js server that will be used for receiving the traffic

Not sure if I understand. Is unavatar a fully stateless service, and simply running the Dockerfile will result in a fully functional instance?

If so, then yes it would be very helpful to have the Docker image in a registry, so that users can self-host without having to fork and maintain.

Kikobeats commented 3 days ago

It's stateless, although it work better if you provide a Redis URI for caching purpose: https://github.com/search?q=repo%3Amicrolinkhq%2Funavatar%20REDIS&type=code

why not use the public endpoint rather than run your own instance? just curiosity 🙂

isaachinman commented 3 days ago

We want to self-host due to the rate limiting. The actual rate limit doesn't seem to be consistent in headers, but from what I gather it's 50 reqs per 24 hours, per IP. That is way too low for our use case.

Thanks for confirming the hosting details!

It would be great to have an image in the registry, especially with an @latest tag so that we can automatically follow releases 🙏