Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Filecoin Station to Umbrel #644

Open
TomKalina opened this issue Dec 10, 2024 · 3 comments
Open

Add Filecoin Station to Umbrel #644

TomKalina opened this issue Dec 10, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@TomKalina
Copy link

Hi there! 👋

Have you ever considered adding Filecoin Station to the Umbrel App Store? Umbrel is a highly popular platform for self-hosted solutions in the crypto community, and integrating Filecoin Station could significantly boost awareness and adoption of your project.

Why Umbrel?

  • Umbrel is widely used in the crypto and Web3 space.
  • Listing Filecoin Station as an app could increase visibility and accessibility for potential users.

Steps to Get Started

  1. Build a Community App
    Start by creating a app with fork Umbrel Community App Store and create app using the docker image

  2. Submit to the Official App Store
    Once the app is fine-tuned and well-tested, you can seek inclusion in the official Umbrel app store.


I have some experience with making umbrel addon so if you would be interested so I am helpful help.

@bajtos
Copy link
Member

bajtos commented Dec 10, 2024

Thank you for the suggestion!

From https://umbrel.com/, I found the docs for app building here:
https://github.com/getumbrel/umbrel-apps/blob/master/README.md

Apps run inside isolated Docker containers, and the only requirement (for now) is that they should have a web-based UI.

We already provide docker images for Station, see https://github.com/filecoin-station/core/pkgs/container/core

There is no web-based UI, though.

I remember discussing that Station Core could provide web UI based on the UI provided by Station Desktop, but I don't remember why we decided against that.

What kind of UI would you find useful inside Umbrel?

FAQs

  1. How do I push app updates?

    Every time you release a new version of your app, you should build, tag, and push the new Docker images to Docker Hub. Then open a new PR on our main app repo (getumbrel/umbrel-apps) with your up-to-date docker image, and updated version and releaseNotes in your app's umbrel-app.yml file.

We will need to automate this step by adding additional steps to our GitHub Actions workflow that is publishing new Docker image versions:

- name: Build and push Docker image
uses: docker/build-push-action@v6
with:
context: .
push: true
tags: |
ghcr.io/filecoin-station/core
ghcr.io/filecoin-station/core:${{ steps.package-version.outputs.current-version }}
platforms: linux/amd64,linux/arm64
cache-from: type=registry,ref=ghcr.io/filecoin-station/core
cache-to: type=inline

@bajtos bajtos added the enhancement New feature or request label Dec 10, 2024
@bajtos
Copy link
Member

bajtos commented Dec 10, 2024

A potentially better approach is to create a new project consuming Station Core in a similar way how Station Desktop does, see main/core.js, and adding a custom Umbrel-specific web UI on top of that.

Station Core was designed for embeddability. Your Umbrel-specific wrapper can use the same APIs that Station Desktop does.

@TomKalina
Copy link
Author

A potentially better approach is to create a new project consuming Station Core in a similar way how Station Desktop does, see main/core.js, and adding a custom Umbrel-specific web UI on top of that.

Station Core was designed for embeddability. Your Umbrel-specific wrapper can use the same APIs that Station Desktop does.

I don't know the internal implementation of the code.

But having a full interface that is in the desktop would be the absolute best solution everything else would be a compromise.

It would allow the client to run nonstop.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants