Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MRColorR authored Feb 13, 2024
1 parent 7419fdd commit 083c3e3
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,33 @@
# Speedshare Unofficial Docker Image
[Github repo](https://github.com/MRColorR/speedshare)
Supports both **x86_64** and **arm64**.
- You won't get much logs, it's normal. Check the dashboard after about half a minute.
- You can pass a specific UUID to the container, so it stays the same after restarts.
# Unofficial SpeedShare Docker Container 🚀
![Docker Pulls](https://img.shields.io/docker/pulls/mrcolorrain/speedshare?style=flat-square&link=https://hub.docker.com/r/mrcolorrain/speedshare)
![Docker Stars](https://img.shields.io/docker/stars/mrcolorrain/speedshare?style=flat-square&link=https://hub.docker.com/r/mrcolorrain/speedshare)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/MRColorR/speedshare/docker-publish.yml?style=flat&link=https%3A%2F%2Fhub.docker.com%2Frepository%2Fdocker%2Fmrcolorrain%2Fspeedshare)

> The auto-update feature is enabled, but untested.

## Quick start
### Docker cli
🌟 **If you find this project helpful, please consider leaving a star. Your support is appreciated!**

## Introduction 📖
This repository hosts the Dockerfile and necessary configurations for the unofficial SpeedShare Docker image. It's designed to facilitate the deployment of SpeedShare in Docker environments, supporting both x86_64 and arm64 architectures. This project is not officially affiliated with SpeedShare.

## Features ✨
- **Multi-Architecture Support**: Compatible with both x86_64 and arm64 architectures.
- **Minimal Configuration**: Easy to set up with minimal configuration required.
- **Persistent UUID**: Supports passing a UUID to maintain device identity across restarts.
- **Auto-Update (Experimental)**: Includes an experimental auto-update feature for the SpeedShare CLI.

## Prerequisites 📋
Ensure Docker is installed on your system. For installation instructions, please refer to the [official Docker documentation](https://docs.docker.com/get-docker/).

## Quick Start 🚀
### Docker cli 🐳
```bash
docker run -d --name speedshare \
-h my_device \
-e CODE=your_authentication_code \
-e SPEEDSHARE_UUID=your_uuid \
mrcolorrain/speedshare
```
### Docker compose
### Docker compose 🐳
```yaml
version: "3.9"
services:
Expand All @@ -28,3 +40,9 @@ services:
- SPEEDSHARE_UUID=your_uuid
restart: unless-stopped
```
Disclaimer ⚠️
This Docker container and its configurations are provided "as is" without warranty of any kind. It's an unofficial build and not officially endorsed by SpeedShare.
Contributing 🤲
Your contributions are welcome! If you'd like to improve the project or fix a bug, please fork the repository and submit a pull request.

0 comments on commit 083c3e3

Please sign in to comment.