mrcolorr/speedshare

Unofficial SpeedShare Docker image for easy deployment and management. With multiarch support (x86_64, arm64,...), auto-updates and persistent UUID features.

Unofficial SpeedShare Docker Container 🚀

🌟 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.

Features ✨

• Alpine Base Image: Utilizes the latest version of Alpine linux for a small footprint.
• Multi-Architecture Support: Supports 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: Always updated to be in line with the latest SpeedShare CLI.

Prerequisites 📋

Ensure Docker is installed on your system. For installation instructions, please refer to the official Docker documentation.

Quick Start 🚀

You can run it easily passing the appropriate values.

• Docker cli 🐳

  docker run -d --name speedshare -h my_device -e CODE=your_authentication_code -e SPEEDSHARE_UUID=your_uuid mrcolorrain/speedshare 

• Docker compose 🐳

  version: "3.9"
  services:
    speedshare:
      container_name: speedshare
      hostname: my_device
      image: mrcolorrain/speedshare
      environment:
        - CODE=your_authentication_code
        - SPEEDSHARE_UUID=your_uuid
      restart: unless-stopped

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. Let's make this project even better, together!

Disclaimer ⚠️

This is an unofficial build and not affiliated or officially endorsed by SpeedShare. This repository (project) and its assets are provided "as is" without warranty of any kind. The author makes no warranties, express or implied, that this project and its assets are free of errors, defects, or suitable for any particular purpose. The author shall not be liable for any damages suffered by any user of this project, whether direct, indirect, incidental, consequential, or special, arising from the use of or inability to use this project, its assets or its documentation, even if the author has been advised of the possibility of such damages.

speedshare's Issues

SpeedShare auto update question

Hello, and thank you for your amazing work on this project. I've been exploring the image and have some thoughts and questions that might help enhance it further:

• It appears the app's installation occurs at runtime via the entrypoint, ensuring the latest version upon first run. However, this approach seems to bypass updates for existing instances and causes a new device to appear on every restart. Could an alternative method ensure continuous updates without sacrificing the benefits of your current strategy?
  • I've noticed potential issues with the device UUID changing with each image update, potentially cluttering the dashboard with multiple device entries. Would it be feasible to allow a persistent UUID through an environment variable for consistency?
• For updates and to install the app direcly in the image building phase, perhaps implementing an MD5 checksum in the GitHub Actions could automate version checks and updates (download app check md5sum if different from the saved one then procees with installing and building steps), pushing these directly to Docker Hub, ready to use.
  • Lastly, as an alternative, considering the speedshare CLI's update command, might there be a way to incorporate automatic updates within running containers, maybe through a scheduled task or similar mechanism this is suboptimal for containers but worth exploring)

These are just some initial thoughts. I'm looking forward to hearing your insights and discussing potential improvements