[Enhancement]: User onboarding Email/SMS

hskrtich commented 1 year ago

Describe the feature/enhancement

When setting up a new user I have started sending an onboarding text or email. It would be nice to automate this. So when a new user is added with an email, the app would send out an email with this info. Maybe even include something how the app works.

I setup an AudioBookShelf account for you!
URL: audiobooks.blah.com
User: newuser01
Pass: yourcoolpass
Android App: 
https://play.google.com/store/apps/details?id=com.audiobookshelf.app
ISO App:
https://testflight.apple.com/join/wiic7QIW

benonymity commented 1 year ago

This would be great! I have a Markdown template for adding new users to my server which has their username and password and instructions for use, but I have to send it to them each time. It would be nice to have this automated, however it would necessitate integration with a SMTP or SMS server which could be beyond the scope of audiobookshelf. Maybe an external script to achieve the same thing that monitors the user endpoint?

hskrtich commented 1 year ago

Mind sharing your template?

Also I dont think adding smtp settings is beyond the scope. Many self hosted projects have some sort of smtp config. Plus it would be nice to be able to do things like self password resets and the like.

advplyr commented 1 year ago

We can support this using the new notification system that was added in 2.2.0. It requires you have Apprise API setup on your server and uses that to send notifications. Apprise will allow you to use email, text messages, push notifications and everything in-between.

I think this is the best way for now without having to build out an entire system of our own.

If we added a "User Created" event here I think we would need to limit it to email and add an email field for accounts.

benonymity commented 1 year ago

Awesome, sounds like it wouldn't be very difficult to implement with Apprise then!

@hskrtich if you still want my template this is it.

Hello!

If you're getting this, welcome to the audiobook server! I hope you enjoy the great variety of stories. I've spent hundreds of hours curating this collection of 700+ books, all hand-labeled with narrator, author, description, series, and more helpful metadata. This sprawling collection of audio files combine with a wonderfully designed server and app to make what I hope is a convenient and enjoyable listening experience for you.

Website

You can simply navigate to https://abs.example.com and sign in with the provided username and password below to access the collection! It should work on any computer-sized display quite well, but trying to get to the website on your mobile phone might be a bit cramped.

App

To access the collection on mobile, use the iOS or Android app. For iOS, download the TestFlight app from the App Store. This intermediary is needed for now because the app is still in beta and has some features that haven't been fully implemented. Lots of work is being done to get the app into the normal App Store soon though! Once you download Testflight (if you are on iOS 13 or above) open this link on your iPhone: https://testflight.apple.com/join/wiic7QIW and follow the instructions, clicking redeem, install, and start testing.

If you are using an Android device, you can download a beta version of the app here.

Once you are in the app, you can put the link https://abs.example.com into the Server Address box, then use your username and password below to log in.

If you have any issues installing it I'd be happy to help you set it up!

Credentials

You can sign into the server with the following information:

Username: username

Password: password

advplyr / audiobookshelf