✨ 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
parent
739fda72c5
commit
b22683d153
|
|
@ -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，用户可以轻松地链接到自己的自定义页面，并为他们的粉丝提供一个方便的地点，让他们能够访问所有需要的链接。
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
## Introduction
|
||||
|
||||
LinkStack is a highly customizable link sharing platform with an intuitive, easy to use user interface.
|
||||
|
||||
## Features
|
||||
|
||||
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.
|
||||
|
|
@ -1,22 +1,32 @@
|
|||
name: LinkStack
|
||||
tags:
|
||||
- 建站
|
||||
title: 高度可定制的链接共享平台，用户界面直观易用
|
||||
description: 高度可定制的链接共享平台，用户界面直观易用
|
||||
- 实用工具
|
||||
title: 高度可定制的链接分享平台
|
||||
description: 高度可定制的链接分享平台
|
||||
additionalProperties:
|
||||
key: linkstack
|
||||
name: LinkStack
|
||||
tags:
|
||||
- Website
|
||||
shortDescZh: 高度可定制的链接共享平台，用户界面直观易用
|
||||
shortDescEn: A highly customizable link sharing platform with an intuitive, easy to use user interface
|
||||
- Tool
|
||||
shortDescZh: 高度可定制的链接分享平台
|
||||
shortDescEn: Highly customizable link sharing platform
|
||||
description:
|
||||
en: A highly customizable link sharing platform with an intuitive, easy to use user interface
|
||||
zh: 高度可定制的链接共享平台，用户界面直观易用
|
||||
en: Highly customizable link sharing platform
|
||||
zh: 高度可定制的链接分享平台
|
||||
zh-Hant: 高度可定製的連結分享平台
|
||||
ja: 高度にカスタマイズ可能なリンク共有プラットフォーム
|
||||
ms: Platform perkongsian pautan yang sangat boleh disesuaikan
|
||||
pt-br: Plataforma de compartilhamento de links altamente personalizável
|
||||
ru: Высоко настраиваемая платформа для обмена ссылками
|
||||
ko: 고도로 사용자 정의 가능한 링크 공유 플랫폼
|
||||
type: website
|
||||
crossVersionUpdate: true
|
||||
limit: 0
|
||||
recommend: 0
|
||||
website: https://linkstack.org
|
||||
github: https://github.com/LinkStackOrg/LinkStack
|
||||
github: https://github.com/linkstackorg/linkstack
|
||||
document: https://docs.linkstack.org
|
||||
architectures:
|
||||
- amd64
|
||||
- arm64
|
||||
- arm/v7
|
||||
- arm/v6
|
||||
|
|
|
|||
|
|
@ -1,9 +0,0 @@
|
|||
CONTAINER_NAME="linkstack"
|
||||
HTTPS_SERVER_NAME="www.example.xyz"
|
||||
HTTP_SERVER_NAME="www.example.xyz"
|
||||
PANEL_APP_PORT_HTTP="40225"
|
||||
PANEL_APP_PORT_HTTPS="40226"
|
||||
PHP_MEMORY_LIMIT="512M"
|
||||
SERVER_ADMIN="admin@example.xyz"
|
||||
TIME_ZONE="Asia/Shanghai"
|
||||
UPLOAD_MAX_FILESIZE="8M"
|
||||
|
|
@ -1,82 +1,30 @@
|
|||
additionalProperties:
|
||||
formFields:
|
||||
- default: 40225
|
||||
edit: true
|
||||
- default: 8080
|
||||
envKey: PANEL_APP_PORT_HTTP
|
||||
labelEn: Application HTTP Port
|
||||
labelZh: 应用 HTTP 端口
|
||||
labelZh: HTTP 端口
|
||||
labelEn: HTTP Port
|
||||
label:
|
||||
en: Application HTTP Port
|
||||
zh: 应用 HTTP 端口
|
||||
zh: HTTP 端口
|
||||
zh-Hant: HTTP 連接埠
|
||||
en: HTTP Port
|
||||
ja: HTTP ポート
|
||||
ko: HTTP 포트
|
||||
ms: Port HTTP
|
||||
pt-br: Porta HTTP
|
||||
ru: HTTP Порт
|
||||
tr: HTTP Portu
|
||||
description:
|
||||
zh: "设置应用的 HTTP 访问端口，有效范围: 1-65535"
|
||||
zh-Hant: "設定應用程式的 HTTP 存取連接埠，有效範圍: 1-65535"
|
||||
en: "Set the HTTP access port for the application, valid range: 1-65535"
|
||||
ja: "アプリケーションのHTTPアクセスポートを設定します。有効範囲: 1-65535"
|
||||
ko: "애플리케이션의 HTTP 접근 포트를 설정합니다. 유효 범위: 1-65535"
|
||||
ms: "Tetapkan port akses HTTP untuk aplikasi, julat sah: 1-65535"
|
||||
pt-br: "Defina a porta de acesso HTTP para o aplicativo, intervalo válido: 1-65535"
|
||||
ru: "Установите порт доступа HTTP для приложения, допустимый диапазон: 1-65535"
|
||||
tr: "Uygulama için HTTP erişim portunu ayarlayın, geçerli aralık: 1-65535"
|
||||
required: true
|
||||
type: number
|
||||
- default: 40226
|
||||
edit: true
|
||||
envKey: PANEL_APP_PORT_HTTPS
|
||||
labelEn: Application HTTPS Port
|
||||
labelZh: 应用 HTTPS 端口
|
||||
label:
|
||||
en: Application HTTPS Port
|
||||
zh: 应用 HTTPS 端口
|
||||
required: true
|
||||
type: number
|
||||
- default: www.example.xyz
|
||||
edit: true
|
||||
envKey: HTTP_SERVER_NAME
|
||||
labelEn: HTTP Server Name
|
||||
labelZh: HTTP 服务器名称
|
||||
label:
|
||||
en: HTTP Server Name
|
||||
zh: HTTP 服务器名称
|
||||
required: true
|
||||
type: text
|
||||
- default: www.example.xyz
|
||||
edit: true
|
||||
envKey: HTTPS_SERVER_NAME
|
||||
labelEn: HTTPS Server Name
|
||||
labelZh: HTTPS 服务器名称
|
||||
label:
|
||||
en: HTTPS Server Name
|
||||
zh: HTTPS 服务器名称
|
||||
required: true
|
||||
type: text
|
||||
- default: admin@example.xyz
|
||||
edit: true
|
||||
envKey: SERVER_ADMIN
|
||||
labelEn: Server Admin
|
||||
labelZh: 服务器管理员
|
||||
label:
|
||||
en: Server Admin
|
||||
zh: 服务器管理员
|
||||
required: true
|
||||
type: text
|
||||
- default: Asia/Shanghai
|
||||
edit: true
|
||||
envKey: TIME_ZONE
|
||||
labelEn: Time zone
|
||||
labelZh: 时区
|
||||
label:
|
||||
en: Time zone
|
||||
zh: 时区
|
||||
required: true
|
||||
type: text
|
||||
- default: 512M
|
||||
edit: true
|
||||
envKey: PHP_MEMORY_LIMIT
|
||||
labelEn: PHP Memory Limit
|
||||
labelZh: PHP 内存限制
|
||||
label:
|
||||
en: PHP Memory Limit
|
||||
zh: PHP 内存限制
|
||||
required: true
|
||||
type: text
|
||||
- default: 8M
|
||||
edit: true
|
||||
envKey: UPLOAD_MAX_FILESIZE
|
||||
labelEn: Upload Max Filesize
|
||||
labelZh: 上传文件最大限制
|
||||
label:
|
||||
en: Upload Max Filesize
|
||||
zh: 上传文件最大限制
|
||||
required: true
|
||||
type: text
|
||||
rule: paramPort
|
||||
|
|
|
|||
|
|
@ -2,29 +2,15 @@ services:
|
|||
linkstack:
|
||||
image: linkstackorg/linkstack:latest
|
||||
pull_policy: always
|
||||
volumes:
|
||||
- ./data:/htdocs
|
||||
ports:
|
||||
- ${PANEL_APP_PORT_HTTP}:80
|
||||
container_name: ${CONTAINER_NAME}
|
||||
restart: always
|
||||
networks:
|
||||
- 1panel-network
|
||||
ports:
|
||||
- "${PANEL_APP_PORT_HTTP}:80"
|
||||
- "${PANEL_APP_PORT_HTTPS}:443"
|
||||
hostname: ${CONTAINER_NAME}
|
||||
environment:
|
||||
- HTTP_SERVER_NAME=${HTTP_SERVER_NAME}
|
||||
- HTTPS_SERVER_NAME=${HTTPS_SERVER_NAME}
|
||||
- SERVER_ADMIN=${SERVER_ADMIN}
|
||||
- TZ=${TIME_ZONE}
|
||||
- PHP_MEMORY_LIMIT=${PHP_MEMORY_LIMIT}
|
||||
- UPLOAD_MAX_FILESIZE=${UPLOAD_MAX_FILESIZE}
|
||||
volumes:
|
||||
- linkstack:/htdocs
|
||||
labels:
|
||||
createdBy: "Apps"
|
||||
|
||||
volumes:
|
||||
linkstack:
|
||||
|
||||
createdBy: Apps
|
||||
networks:
|
||||
1panel-network:
|
||||
external: true
|
||||
|
|
|
|||
|
|
@ -0,0 +1,4 @@
|
|||
install -d -m 777 ./data
|
||||
CONTAINER_ID=$(docker create --pull always linkstackorg/linkstack:latest)
|
||||
docker export $CONTAINER_ID | tar -x -C ./data htdocs --strip-components=1
|
||||
docker rm $CONTAINER_ID
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 3.4 KiB After Width: | Height: | Size: 7.0 KiB |
Loading…
Reference in New Issue