1
0

feat(linkstack): update documentation and simplify application configuration

- Rewrite README.md in Chinese and add README_en.md in English to focus on product introduction and main features
- Update data.yml with improved multilingual descriptions, architecture support, and simplified form fields (only HTTP port configuration)
- Simplify docker-compose.yml by removing unnecessary environment variables and using volume mount instead of named volume
- Add init.sh script for container initialization and update logo.png file
- Remove .env.sample file with complex environment variables
This commit is contained in:
pooneyy
2026-01-06 02:20:39 +08:00
parent 739fda72c5
commit b22683d153
8 changed files with 66 additions and 184 deletions

View File

@@ -1,75 +1,9 @@
# 使用说明
## 产品介绍
- 数据默认以存储卷方式存储,类似卷`linkstack_linkstack`
LinkStack 是一个高度可定制的链接分享平台,拥有直观、易于使用的用户界面。
- 需要注意,当前面板自带备份不会备份到存储卷
## 主要功能
# 原始相关
***
<p align="center">
<img width="200px" src="https://raw.githubusercontent.com/LinkStackOrg/branding/main/logo/svg/logo_animated.svg"><br>
<br>
<picture>
<source media="(prefers-color-scheme: dark)" width="400px" srcset="https://raw.githubusercontent.com/LinkStackOrg/branding/main/logo/png/wordmark_light.png">
<img width="400px" src="https://raw.githubusercontent.com/LinkStackOrg/branding/main/logo/png/wordmark_dark.png">
</picture>
</p>
LinkStack 是一个独特的平台,提供了一种高效的管理和在线分享链接的解决方案。平台提供了一个类似于 Linktree 的网站,使用户能够克服社交媒体平台上只能添加一个链接的限制。
<h3 align="center"><b>Open-Source Linktree Alternative</b></h3>
<h3 align="center">LinkStack is a highly customizable link sharing platform<br>with an intuitive, easy to use user interface.</h3>
<br>
<p align="center">
<a href="#Function">Function</a>
<a href="#About">About</a>
<a href="#Instances">Instances</a>
</p>
<p align="center">
<a href="https://github.com/linkstackorg/linkstack/stargazers"><img alt="GitHub Repo stars" src="https://img.lss.ovh/github/stars/julianprieber/littlelink-custom?label=Star%20the%20project&logo=GitHub"></a>
<a href="https://mstdn.social/@linkstack"><img alt="Mastodon Follow" src="https://img.lss.ovh/mastodon/follow/110147874401985724?domain=http%3A%2F%2Fmstdn.social&style=social"></a>
<a href="https://discord.linkstack.org"><img alt="Discord online user count" src="https://img.lss.ovh/discord/955765706111193118?color=4A55CC&label=Discord&logo=Discord&style=flat"></a>
</p>
<p align="center">
<a href="https://github.com/sponsors/julianprieber"><img alt="GitHub spomsors" src="https://img.lss.ovh/github/sponsors/JulianPrieber?color=BF4B8A&logo=githubsponsors&style=flat&label=Sponsor%20us%20on%20Github"></a>
<a href="https://patreon.com/julianprieber"><img alt="Patreon" src="https://img.lss.ovh/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Djulianprieber%26type%3Dpatrons&style=flat&logo=patreon"></a>
<a href="https://liberapay.com/LittleLink-Custom"><img src="https://img.lss.ovh/liberapay/patrons/LittleLink-Custom?logo=liberapay&label=LiberaPay patrons"></a>
</p>
---
<p align="center">
<a href="https://github.com/linkstackorg/linkstack/releases/latest/download/linkstack.zip"><img src="https://raw.githubusercontent.com/LinkStackOrg/branding/main/badges/png/download_latest.png" alt="Download latest" width="380" ></a>
<br>
<a href="https://github.com/linkstackorg/linkstack/releases"><img alt="GitHub release (latest by date)" src="https://img.lss.ovh/github/v/release/JulianPrieber/LittleLink-Custom?label=Latest%20release"></a>
</p>
---
<a name="Function"></a>
## Function
LinkStack: The Ultimate Link Management Solution
LinkStack is a unique platform that provides an efficient solution for managing and sharing links online. Our platform offers a website similar to Linktree, which allows users to overcome the limitation of only being able to add one link on social media platforms.
With LinkStack, users can easily link to their own custom page and provide their followers with access to all the links they need in one convenient location. What sets LinkStack apart from other link management platforms is its flexibility, which allows users to host their links on their own web server or web hosting provider. This provides users with complete control over their online presence and ensures that their links are easily accessible.
Additionally, LinkStack allows other users to register and create their own links, making it an ideal solution for businesses and organizations looking to manage multiple links. With our user-friendly Admin Panel, managing and accessing other users' links is easy.
<br>
<a name="About"></a>
## About
With LinkStack, our mission is to provide users with a free and privacy-focused solution for managing and sharing links online. We believe that everyone should have access to a customizable link-sharing platform without sacrificing their privacy and control over their data.
To achieve this mission, we offer a self-hosted option for users who want complete control over their data without having it sold to third-party companies. Our platform can be easily implemented through a simple **drag and drop** process, eliminating the need for complex terminal commands or source code manipulation.
For those who may not have the technical expertise to self-host, we also offer free instances of our platform while still prioritizing their privacy. Our platform offers many of the same features and options as commercial link-sharing platforms while maintaining the values of privacy and autonomy.
Our goal is to provide a free version of a link-sharing service, similar to Linktree, while empowering users to take ownership of their data. We will never sell user data and believe in providing a trustworthy and transparent solution for managing and sharing links online.
<br>
使用 LinkStack用户可以轻松地链接到自己的自定义页面并为他们的粉丝提供一个方便的地点让他们能够访问所有需要的链接。