https://github.com/iamvikshan/bento
Add custom domain to your bento profile
https://github.com/iamvikshan/bento
bento linkinbio
Last synced: about 2 months ago
JSON representation
Add custom domain to your bento profile
- Host: GitHub
- URL: https://github.com/iamvikshan/bento
- Owner: iamvikshan
- Created: 2023-10-29T11:00:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-19T05:53:49.000Z (2 months ago)
- Last Synced: 2025-04-06T05:13:54.120Z (about 2 months ago)
- Topics: bento, linkinbio
- Language: JavaScript
- Homepage: https://bento-vikshan.koyeb.app
- Size: 137 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Custom Domain for Bento Profile
Transform your Bento profile with a personalized domain name! Bento does not have an official way to do this, so i thought this might be a workaround.
> [!TIP]
> - To make changes, navigate to your official [bento profile](bento.me) and make them there.
> - You do not need to re-deploy the app, it will pull those changes before you can even save the XD!
> In other words, as long as your deployment is smooth, you will never think about it, just share your custom domain link, but use bento as normal! HOW COOL IS THAT!
## ✨ Features
- Easy custom domain setup
- Multiple deployment options
- SSL support
- PM2 process management
- Apache2/Nginx compatibility
## 📋 Prerequisites
Before you begin, ensure you have:
- A computer/VPS running Windows, Linux, macOS, or Ubuntu 20.04+, or a docker image
- [bun](https://bun.sh) v1.1.36 or later
- A [Bento](https://bento.me) account
- A custom domain name
- [PM2](https://pm2.keymetrics.io/) (optional)
- [Apache2](https://httpd.apache.org/) (Required for VPS)
- [Certbot](https://certbot.eff.org/) (Required for SSL on VPS)
> [!TIP]
> Get $300 free credit on Vultr to try your app! [Claim now](https://go.vikshan.tech/vultr)
### 💻 Recommended VPS Providers
- [Ionos](https://go.vikshan.tech/ionos) - Special discount available
- [Vultr](https://go.vikshan.tech/vultr) - $300 free credit
- [DigitalOcean](https://go.vikshan.tech/digitalocean) - $200 free credit
- [Hostinger](https://go.vikshan.tech/hostinger) - Discounted rates
- [BigRock VPS](https://go.vikshan.tech/bigrock) - Special offers
- [HostGator](https://go.vikshan.tech/hostgator) - Exclusive deals
> [!NOTE]
> Need help with setup? I'm an Ionos Partner and can assist you! Contact me at
> [Vikshan](https://go.vikshan.tech/ionos-partner)
## 🚀 Installation
### Local/VPS Installation
1. Clone and install dependencies:
```bash
git clone https://github.com/iamvikshan/bento.git
cd bento
bun i
```
2. Create environment variables:
```bash
# Create .env file
echo "BENTO_USERNAME=your_username" > .env
```
3. Start the application:
```bash
bun start
```
4. Run tests (optional):
```bash
bun test
```
> [!IMPORTANT]
> When using a VPS, make sure to set up a reverse proxy using Apache2 or Nginx. See the
> [Apache2 guide](https://docs.vikshan.tech/selfhost/dashboard/domain) or
> [Nginx guide](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/).
## ☁️ Cloud Deployment Options
1. ⭐ Star and [fork](https://github.com/iamvikshan/bento/fork) this repository
### Deploy to Zeabur
1. Create a [Zeabur account](https://zeabur.com?referralCode=vikshan&utm_source=vikshan)
2. Select "Deploy from GitHub" in your dashboard
3. Configure environment variables:
- `BENTO_USERNAME`: Your Bento username
> [!NOTE]
> Remove the `.env` file if you're setting variables in Zeabur dashboard to avoid conflicts
### Deploy to Koyeb (Recommended)
1. [Create a Koyeb account](https://app.koyeb.com/signup)
2. Deploy from your GitHub repository or
[click here](https://app.koyeb.com/deploy?type=git&repository=github.com/iamvikshan/bento&name=bento&service_type=web&builder=dockerfile)
to automatically create using this repo as template.
3. Set required environment variables
> [!WARNING]
> Custom domains require a paid Koyeb plan
### Deploy to Heroku
1. [Create a Heroku account](https://signup.heroku.com/)
2. Click
[here to deploy](https://dashboard.heroku.com/new?template=https%3A%2F%2Fgithub.com%2Fvixshan%2Fbento)
using this repo as a template, or use your own fork.
3. Configure custom domain in Settings → Domains
4. Enable auto-deploys in Deploy → Deployment method
### Deploy to Railway
1. Create a [Railway account](https://railway.com?referralCode=HB99pt) if you don't have one.
2. [Click here](https://railway.com/template/6fVSiZ?referralCode=HB99pt) to deploy using this repo
as a template.
3. Railway will automatically detect the project and set up the necessary environment.
4. You'll be prompted to configure environment variables:
- `BENTO_USERNAME`: Your Bento username
5. Click "Deploy" to start the deployment process.
6. Once deployed, you'll get a URL to access your Bento profile with a custom domain.
> [!NOTE]
> Railway provides a free tier with limited resources. For production use, consider
> upgrading to a paid plan. You can also configure a custom domain with your Railway deployment.
> Refer to the Railway
> [documentation](https://docs.railway.com/guides/public-networking#custom-domains) for more details
> on custom domains and other features.
### Additional Deployment Options
- **Okteto**: [Documentation](https://www.okteto.com/docs/)
- **Repl.it**: [Documentation](https://docs.replit.com/)
- **Docker**: [Documentation](https://docs.docker.com/)
> [!CAUTION]
> Known issues:
> 1. Images may not persist due to caching. In case that happens, re-add those images in bento or use VPS deployment for best results.
> 2. Maps do not work
## 🤝 Contributing
Contributions are always welcome! If you find bugs or have suggestions:
1. [Fork](https://github.com/iamvikshan/bento/fork) the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Open a [Pull Request](https://github.com/iamvikshan/bento/compare)
> [!TIP]
> If this project helped you, please consider:
>
> - Giving it a star ⭐
> - [Becoming a sponsor](https://github.com/sponsors/iamvikshan)
> - Checking out my [other projects](https://github.com/iamvikshan?tab=repositories)
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Activity Graph
## 💪 Powered By
