Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tanq16/local-content-share
Web app with frontend to share content within local network devices. Intended for homelab use.
https://github.com/tanq16/local-content-share
docker file-sharing golang homelab text-sharing webapp
Last synced: about 1 month ago
JSON representation
Web app with frontend to share content within local network devices. Intended for homelab use.
- Host: GitHub
- URL: https://github.com/tanq16/local-content-share
- Owner: Tanq16
- License: mit
- Created: 2023-04-23T04:42:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-14T15:06:22.000Z (about 1 month ago)
- Last Synced: 2024-12-14T15:30:49.682Z (about 1 month ago)
- Topics: docker, file-sharing, golang, homelab, text-sharing, webapp
- Language: CSS
- Homepage:
- Size: 2.52 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Local Content Share
A simple web application for sharing content (files and text) within your local network across any device. The app can be launched via its binary or as a container. The primary features are:
- Make arbitrary text content available for viewing on any machine/smartphone in the local network
- Upload files and make them available across your local network
- Access content through a clean and modern interface with dark mode support that maintains its good looks even on mobile aspect ratio
- Pure HTTP API and no use of websockets, which means no external communications (like for TURN) needed
- It can also be installed as a PWA (so it shows as an icon in a mobile home screens)
> [!NOTE]
> This application is meant to be deployed within your homelab only. There is no authentication mechanism here.
## Screenshots
| | Desktop View | Mobile View |
| --- | --- | --- |
| Light | 
| 
|
| Dark | 
| 
|
## Usage
### Using Docker
```bash
mkdir $HOME/.localcontentshare
```
```bash
docker run --name local-content-share -p 8080:8080 \
-v $HOME/.localcontentshare:/app/data tanq16/local-content-share:latest
```
The application will be available at `http://localhost:8080`
You could also use the following compose file with container managers like Portainer and Dockge:
```yaml
services:
contentshare:
image: tanq16/local-content-share:main
container_name: local-content-share
volumes:
- /home/tanq/lcshare:/app/data
ports:
- 5000:8080
```
> [!WARNING]
> The public image built via GitHub actions only builds an x86-64 image. If you need an ARM variant, just run `docker build -t lcshare:local .` after cloning the repo. Then for the image use `lcshare:local` instead of the tag mentioned above.
### Using Binary
1. Download the appropriate binary for your system from the [latest release](https://github.com/tanq16/local-content-share/releases/latest)
2. Make the binary executable (Linux/macOS):
```bash
chmod +x local-content-share-*
```
3. Run the binary:
```bash
./local-content-share-*
```
The application will be available at `http://localhost:8080`
## Building Binary from Source
Requirements: `Go 1.23` or later
```bash
git clone https://github.com/tanq16/local-content-share.git
cd local-content-share
go build .
./local-content-share
```
## Interface Tips
- To share text content:
- Type or paste your text in the text area
- Click the send button (like the telegram arrow)
- It will set a timestamp-based file name
- To rename files (text items only):
- Click the pencil icon and provide the new name
- It will automatically append 4 random digits if your input isn't unique
- To share files:
- Click the upload button
- Select your file
- It will automatically append 4 random digits if filename isn't unique
- To view/download content:
- Text content: click the eye icon (shows raw text)
- Files: click the download icon
- To delete content:
- Click the trash icon next to the item box
## Directory Structure
The application creates a `data` directory to store all uploaded files and text content. Make sure the application has write permissions for the directory where it runs.