simple-links/README.md

136 lines
4.0 KiB
Markdown
Raw Normal View History

2023-07-02 13:41:28 +00:00
# Simple Links
2023-07-01 20:43:53 +00:00
2023-07-02 13:41:28 +00:00
Simple Links is a lightweight alternative to Linktree and others.
## Features
- Simple and lightweight
- Easy to use
- Customizable
- Open source
2023-07-02 21:39:42 +00:00
## Preview
![Preview](/media/preview.png)
## How to install Simple Links
2023-07-02 13:41:28 +00:00
1. Ensure you have Docker and Docker Compose installed.
2. Copy the `docker-compose.yml` and `config.json` to the folder where you want to run the application.
3. Edit the `config.json` to have your settings in it.
4. Run `docker compose up` to see if the application starts.
5. Visit http://server_ip:3000
6. To make the application run in the background use `docker compose up -d`
## How to update Simple Links
1. Go to where Simple Links is installed
2. Run `docker compose pull`
3. Run `docker compose up -d`
4. The application is now updated
2023-07-12 08:53:46 +00:00
## What if I don't want buttons or icon only links?
Just simply remove it from the config and it will not show anymore
2023-07-12 08:55:09 +00:00
## Help!!! I'm getting an error when launching it
### Config Issue
If your error looks similar to this you are most likely missing part of the config, as some new things may have been added.
```bash
simple-links | Type error: Property 'theme' does not exist on type '{ name: string; description: string; avatar: string; background: { showBackground: boolean; blur: boolean; darken: { enabled: boolean; amount: number; }; backgroundImage: string; }; infoCard: { transparency: number; }; metadata: { ...; }; options: { ...; }; analytics: { ...; }; links: { ...; }[]; }'.
```
## Config Example
```json
{
2023-07-10 04:06:28 +00:00
"name": "Your Name", // The name you want to display on the site
"description": "A description about yourself", // The description you want to use
"avatar": "https://cdn.fascinated.cc/KWprz2.jpg", // The avatar that is shown at the top of the site
2023-07-10 07:22:17 +00:00
// or use a local image
2023-07-10 07:39:28 +00:00
"avatar": "/avatar.webp",
2023-07-12 08:40:24 +00:00
// If you want to use a custom (not dark) background
2023-07-10 04:06:28 +00:00
"background": {
"showBackground": true, // Whether it is enabled or not
"blur": true, // Should we blur the background?
"darken": {
// Should we darken the background?
"enabled": true,
"amount": 0.7
},
2023-07-10 07:22:17 +00:00
"backgroundImage": "https://cdn.fascinated.cc/8twdW8.jpg", // The image to use in the background
// or use a local image
"backgroundImage": "/background.jpg"
2023-07-10 04:06:28 +00:00
},
"theme": "dark", // "dark" or "light" themes
2023-07-12 08:40:24 +00:00
// The card that displays your info and buttons
2023-07-10 04:06:28 +00:00
"infoCard": {
"transparency": 0.85 // How transparent should it be?
},
2023-07-12 08:40:24 +00:00
// Website options
2023-07-10 04:06:28 +00:00
"options": {
"showSourceLink": true // Should we show the "Source Code" link
},
2023-07-12 08:40:24 +00:00
// Search engine and embedding metadata (discord, twitter, etc embeds)
2023-07-10 04:06:28 +00:00
"metadata": {
"title": "Your Name", // The title of the embed
"description": "website description", // The description of the embed
"themeColor": "#6441a5", // The color of the embed
"authors": [
// SEO metadata
{
"name": "Fascinated",
"url": "https://fascinated.cc"
}
]
},
2023-07-12 08:40:24 +00:00
// The buttons to show links for
2023-07-10 04:06:28 +00:00
"links": [
{
"title": "Git", // The shown title of the button
"url": "https://git.fascinated.cc", // Where the button goes to when clicked
"icon": "fab fa-github", // The icon of the button (can be removed to show no icon)
"color": {
// The color of the icon (tailwindcss colors)
"normal": "bg-green-700"
}
},
{
"title": "Twitch",
"url": "https://twitch.tv/fascinated_",
"icon": "fab fa-twitch",
"color": {
"normal": "bg-[#6441a5]"
}
},
{
"title": "Documentation",
"url": "https://docs.fascinated.cc",
"color": {
"normal": "bg-neutral-700"
}
}
2023-07-12 08:40:24 +00:00
],
// Icon only links
"socialLinks": [
{
2023-07-12 09:02:26 +00:00
"icon": "fab fa-twitter", // The icon to use
"color": "#1DA1F2", // An optional color
"url": "https://twitter.com" // The link to go to
2023-07-12 08:40:24 +00:00
},
{
"icon": "fab fa-reddit",
2023-07-12 09:02:26 +00:00
"color": "#FF4300",
2023-07-12 08:40:24 +00:00
"url": "https://www.reddit.com/user/ImFascinatedMC"
2023-07-12 09:02:26 +00:00
},
{
"icon": "fab fa-git-alt",
"url": "https://git.fascinated.cc"
2023-07-12 08:40:24 +00:00
}
2023-07-10 04:06:28 +00:00
]
}
```