Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/techno-tim/littlelink-server
A lightweight, open source, stateless, and self-hosted alternative to linktree in a Docker container!
https://github.com/techno-tim/littlelink-server
docker express javascript link linktree node nodejs react reactjs tree
Last synced: about 1 month ago
JSON representation
A lightweight, open source, stateless, and self-hosted alternative to linktree in a Docker container!
- Host: GitHub
- URL: https://github.com/techno-tim/littlelink-server
- Owner: techno-tim
- License: mit
- Created: 2021-08-10T02:53:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T18:33:21.000Z (2 months ago)
- Last Synced: 2024-09-28T12:40:14.503Z (about 2 months ago)
- Topics: docker, express, javascript, link, linktree, node, nodejs, react, reactjs, tree
- Language: JavaScript
- Homepage: https://links.technotim.live
- Size: 5.89 MB
- Stars: 900
- Watchers: 12
- Forks: 164
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-homelab - LittleLink-Server - Server](https://img.shields.io/github/stars/techno-tim/littlelink-server?style=flat)  | A lightweight, open source, stateless, and self-hosted alternative to linktree in a Docker container! | (Apps / Tools)
README
# 🔗 LittleLink-Server
LittleLink is a lightweight DIY alternative to services like [Linktree](https://linktr.ee)
and [many.link](https://many.link/).
Inspired by [littlelink](https://github.com/sethcottle/littlelink).
## 👇 What is LittleLink-Server?
LittleLink-Server is based on the great work from [littlelink](https://github.com/sethcottle/littlelink), a lightweight DIY alternative to services like [Linktree](https://linktr.ee) and [many.link](https://many.link/). LittleLink and LittleLink-Server is built using [Skeleton](http://getskeleton.com/), a dead simple, responsive boilerplate—we just stripped out some additional code you wouldn't need and added in branded styles for popular services. 😊
It takes the same simple approach to a link page and hosts it within a NodeJS server with React Server Side Rendering, containerized for you to use. Now, customizing `LittleLink` with `littlelink-server` is as easy as passing in some environment variables. If you need help configuring this, please see this [video](https://youtu.be/42SqfI_AjXU) at explains everything and a live example at [links.technotim.live](https://links.technotim.live/).
## ⭐ Features
- Over 60+ brand buttons with more able to be requested
- Customisable Themes
- Analytics Support
- Health Check Support
- A fully customisable docker-compose
## 🚀 Getting Started
Check the [docker-compose.yml](/docker-compose.yml) file for all supported buttons and configuration!
The example below will generate a site exactly like
### Using Docker-Compose
```yml
version: "3.0"
services:
littlelink-server:
image: ghcr.io/techno-tim/littlelink-server:latest
# dockerhub is also supported timothystewart6/littlelink-server
# image: timothystewart6/littlelink-server:latest
container_name: littlelink-server
environment:
- META_TITLE=Techno Tim
- META_DESCRIPTION=Software Engineer | Gamer | Twitch Streamer | Content Creator on YouTube | Homelab | 🇺🇸 🇯🇵 | Full Nerd
- META_AUTHOR=Techno Tim
- META_KEYWORDS=HomeLab, HTML, CSS, Engineering
- LANG=en
- META_INDEX_STATUS=all
- OG_SITE_NAME=Techno Tim
- OG_TITLE=Techno Tim
- OG_DESCRIPTION=The home of Techno Tim
- OG_URL=https://technotim.live
- OG_IMAGE=https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_400x400.jpg
- OG_IMAGE_WIDTH=400
- OG_IMAGE_HEIGHT=400
- GA_TRACKING_ID=G-XXXXXXXXXX
- THEME=Dark
- FAVICON_URL=https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_200x200.jpg
- AVATAR_URL=https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_200x200.jpg
- AVATAR_2X_URL=https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_400x400.jpg
- AVATAR_ALT=Techno Tim Profile Pic
- NAME=TechnoTim
- BIO=Software Engineer | Gamer | Twitch Streamer | Content Creator on YouTube | Homelab | 🇺🇸 🇯🇵 | Full Nerd
# use ENV variable names for order, listed buttons will be boosted to the top
- BUTTON_ORDER=YOUTUBE,TWITCH,TWITTER,GITHUB,INSTAGRAM,LINKED_IN,DISCORD,FACEBOOK,TIKTOK,PATREON,GEAR,DOCUMENTATION
# you can render an unlimited amount of custom buttons by adding
# the CUSTOM_BUTTON_* variables and by using a comma as a separator.
- CUSTOM_BUTTON_TEXT=Documentation,Recommended Gear
- CUSTOM_BUTTON_URL=https://l.technotim.live/docs,https://l.technotim.live/gear
- CUSTOM_BUTTON_COLOR=#000000,#000000
- CUSTOM_BUTTON_TEXT_COLOR=#ffffff,#ffffff
- CUSTOM_BUTTON_ALT_TEXT=Tech documentation site for my videos and more,Recommended Gear
- CUSTOM_BUTTON_NAME=DOCUMENTATION,GEAR
- CUSTOM_BUTTON_ICON=fas file-alt,fas fa-cog
- GITHUB=https://l.technotim.live/github
- TWITTER=https://l.technotim.live/twitter
- INSTAGRAM=https://l.technotim.live/instagram
- LINKED_IN=https://l.technotim.live/linkedin
- YOUTUBE=https://l.technotim.live/subscribe
- TWITCH=https://l.technotim.live/twitch
- DISCORD=https://l.technotim.live/discord
- TIKTOK=https://l.technotim.live/tiktok
- FACEBOOK=https://l.technotim.live/facebook
- PATREON=https://l.technotim.live/patreon
- FOOTER=Techno Tim © 2022
ports:
- 8080:3000
restart: unless-stopped
security_opt:
- no-new-privileges:true
```
### Using Docker
```bash
docker run -d \
--name=littlelink-server \
-p 8080:3000 \
-e META_TITLE='Techno Tim' \
-e META_DESCRIPTION='Techno Tim Link page' \
-e META_AUTHOR='Techno Tim' \
-e META_KEYWORDS='HomeLab, HTML, CSS, Engineering' \
-e LANG=en \
-e META_INDEX_STATUS='noindex' \
-e THEME='Dark' \
-e FAVICON_URL='https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_200x200.jpg' \
-e AVATAR_URL='https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_200x200.jpg' \
-e AVATAR_2X_URL='https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_400x400.jpg' \
-e AVATAR_ALT='Techno Tim Profile Pic' \
-e NAME='TechnoTim' \
-e BIO='Software Engineer | Gamer | Twitch Streamer | Content Creator on YouTube | Homelab | 🇺🇸 🇯🇵 | Full Nerd' \
-e GITHUB='https://l.technotim.live/github' \
-e TWITTER='https://l.technotim.live/twitter' \
-e INSTAGRAM='https://www.instagram.com/techno.tim' \
-e LINKED_IN='https://l.technotim.live/linkedin' \
-e YOUTUBE='https://l.technotim.live/subscribe' \
-e TWITCH='https://l.technotim.live/twitch' \
-e DISCORD='https://l.technotim.live/discord' \
-e TIKTOK='https://l.technotim.live/discord' \
-e KIT='https://l.technotim.live/gear' \
-e FOOTER=Techno Tim © 2022 \
--restart unless-stopped \
ghcr.io/techno-tim/littlelink-server:latest
```
### Using Kubernetes
[Unofficial helm chart provided by k8s-at-home](https://github.com/k8s-at-home/charts/tree/master/charts/stable/littlelink-server)
```bash
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install littlelink-server \
--set env.TZ="America/New York" \
--set env.META_TITLE="TechnoTim"
k8s-at-home/littlelink-server
```
Or use a values.yaml files
`helm install littlelink-server k8s-at-home/littlelink-server -f values.yaml`
## 🔧 Configuration
### Analytics Support
#### Google Analytics
See [Getting Started with Analytics](https://support.google.com/analytics/answer/1008015?hl=en). After getting your GA Tracking Id, use your tracking Id as environment variable like `GA_TRACKING_ID=G-XXXXXXXXXX` (See the example below)
All buttons clicked will be tracked automatically if `GA_TRACKING_ID` exists.
Sample event for YouTube button.
```javascript
window.gtag('event', 'youtube-button');
```
#### Umami
See [Adding a website & Collecting data](https://umami.is/docs/collect-data) page to add and generate your tracking code.
Generated tracking code should look like:
```javascript
```
Use `data-website-id` as environment variable `UMAMI_WEBSITE_ID`. Take the initial root host of `src` as `UMAMI_APP_URL`, and the name of the script (i.e. `umami.js` or `script.js`) as `UMAMI_SCRIPT_NAME`.
Sample event for YouTube button.
```javascript
window.umami.track('youtube-button');
```
#### Matomo
See [Installing Matomo fo how to configure analytics](https://matomo.org/docs/installation/) and [how to find your site id](https://matomo.org/faq/general/faq_19212/)
Use `MATOMO_URL` for your URL and `MATOMO_SITE_ID` for your site id
Sample event for YouTube button.
```javascript
window._paq.push(['trackEvent', 'youtube-button']]);
```
### Health Check
A health check endpoint exists on `/healthcheck`. If healthy, it will return with a `200` and the following response:
```json
{
"status": "ok"
}
```
To skip express from logging these calls, add the environment variable:
```bash
SKIP_HEALTH_CHECK_LOGS=true
```