Wishlist is a self-hosted wishlist application that you can share with your friends and family. You no longer have to wonder what to get your parents for the holidays, simply check their wishlist and claim any available item. With a simple user interface, even the grandparents can get involved!
- Claim items on a wishlist
- Check off claimed items as purchased
- Automatically fetch product data from URL
- Invite users via email (SMTP configuration required)
- Options for suggestions
- PWA Support
- Group support
- Draw names for a "secret santa" experience
Getting started is simple with Docker Compose
Create a docker-compose.yaml file:
version: "3"
services:
wishlist:
container_name: wishlist
image: ghcr.io/cmintey/wishlist:latest
ports:
- 3280:3280
volumes:
- ./uploads:/usr/src/app/uploads # This is where user image uploads will be stored
- ./data:/usr/src/app/data # This is where the sqlite database will be stored
environment:
ORIGIN: https://wishlist.example.com # The URL users will connect to
TOKEN_TIME: 72 # hours until signup and password reset tokens expireThen simply run docker compose up -d.
You can now connect to your application at http://<host>:3280.
Note
Set the
ORIGINenvironment variable to the url you will be connecting to, otherwise you will experience issues
Wishlist has support for multiple wishlist groups. For example, you can have one group for friends and one for family. The wishes on these lists will be completely separate. You can switch between groups using the menu when you click on your profile picture.
Currently, anyone can create a group. The group creator is automatically added as a "manager" of the group. A Group Manager can invite users to Wishlist and add/remove existing users to the group they manage. The Group Manager can also delete the group. An Admin will have the same permissions as the Group Manager.
There are several configuration options in the admin panel.
By default, anyone with the url can signup for an account. You can turn this off and have it be invite only.
If you have SMTP enabled, then you can enter a user's email and an invite link will be sent there. Otherwise, an invite link will be generated for you to copy and send to the user manually.
Suggestions are enabled by default. With suggestions enabled, you will be able to add items to another person's wishlist. There are a few different suggestion methods.
In this mode, the suggested item will need to be approved by the suggestee in order for it to show up on their wishlist. If the item is approved, it can be edited and deleted by the suggestee at any time.
In this mode, the suggested item will be automatically approved and added to the wishlist. Similar to the previous method, the item can be edited and delted by the suggestee at any time.
In this mode, the suggested item is automatically approved and added to the wishlist. However, the item only shows for everyone except for the suggestee. The suggestee cannot see and therefore cannot edit or delete the item once it has been added.
SMTP does not need to be configured for the app to function. SMTP enables inviting users via email and the forgot password flow. Without SMTP, you can still manually generate invite links and forgot password links.