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
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2023-07-09 18:28:50 +00:00
|
|
|
## How to install Simple Links
|
2023-07-02 13:41:28 +00:00
|
|
|
|
2023-07-09 18:28:50 +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-13 09:20:36 +00:00
|
|
|
## Support
|
|
|
|
|
|
|
|
|
|
If you need any help, you can contact me on my Discord server [here](https://discord.gg/yjj2U3ctEG) or open a issue!
|
|
|
|
|
|
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 16:58:47 +00:00
|
|
|
## Showing Discord status
|
|
|
|
|
|
|
|
|
|
You must be in the [lanyard server](https://discord.gg/UrXF2cfJ7F) for it to work.
|
