diff --git a/.gitignore b/.gitignore index d35701f..496ee2c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1 @@ -.DS_Store -*.pem \ No newline at end of file +.DS_Store \ No newline at end of file diff --git a/README.md b/README.md index d592602..3ce8833 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ -### Todo +## Umbrel Community App Store Template -Add step-by-step guide on using this template repository to start your own community app store. \ No newline at end of file +This repository is a template to create an Umbrel Community App Store. These additional app stores allow developers to distribute applications without submitting to the [Official Umbrel App Store](https://github.com/getumbrel/umbrel-apps). + +### Technical Details + +The `umbrel-app-store.yml` file defines two important properties: +- `id` - This is used as a prefix for all apps within the community app store. You **MUST** prefix your application id with your app store ID. For example, this template defines `sparkles` as a community app store ID and we have a `hello world` app. The app ID therefore should be: `sparkles-hello-world` +- `name` - This name appears within the Umbrel user interface when users explore apps within these community app stores. + + +### Testing + +To test your community app store, you can add this repository through the Umbrel user interface, or using Umbrel's CLI. + +To add an app store: +``` +sudo ~/umbrel/scripts/repo add https://github.com/getumbrel/umbrel-community-app-store.git +``` + +To install an app from the app store +``` +sudo ~/umbrel/scripts/app install sparkles-hello-world +``` + +To remove an app store: +``` +sudo ~/umbrel/scripts/repo remove https://github.com/getumbrel/umbrel-community-app-store.git +``` \ No newline at end of file diff --git a/hello-world/docker-compose.yml b/sparkles-hello-world/docker-compose.yml similarity index 55% rename from hello-world/docker-compose.yml rename to sparkles-hello-world/docker-compose.yml index 50771ab..066b8c2 100644 --- a/hello-world/docker-compose.yml +++ b/sparkles-hello-world/docker-compose.yml @@ -4,7 +4,8 @@ services: app_proxy: environment: - APP_HOST: hello_world_server_1 + # The format here is: __1 + APP_HOST: sparkles-hello-world_server_1 APP_PORT: 3000 server: diff --git a/hello-world/umbrel-app.yml b/sparkles-hello-world/umbrel-app.yml similarity index 94% rename from hello-world/umbrel-app.yml rename to sparkles-hello-world/umbrel-app.yml index 398ef13..0a12013 100644 --- a/hello-world/umbrel-app.yml +++ b/sparkles-hello-world/umbrel-app.yml @@ -1,5 +1,5 @@ manifestVersion: 1 -id: hello-world +id: sparkles-hello-world name: Hello World tagline: Replace this tagline with your app's tagline icon: https://svgur.com/i/mvA.svg diff --git a/umbrel-app-store.yml b/umbrel-app-store.yml new file mode 100644 index 0000000..8156262 --- /dev/null +++ b/umbrel-app-store.yml @@ -0,0 +1,2 @@ +id: "sparkles" # Choose the ID for your app store. This should contain only alphabets ("a to z") and dashes ("-"). +name: "Sparkles" # Choose the name of your app store. It will show up in the UI as " App Store". \ No newline at end of file diff --git a/umbrel-repo.yml b/umbrel-repo.yml deleted file mode 100644 index 869d70c..0000000 --- a/umbrel-repo.yml +++ /dev/null @@ -1,2 +0,0 @@ -id: "hello-world" # Choose the ID for your app store. This should contain only alphabets ("a to z") and dashes ("-"). -name: "Hello World" # Choose the name of your app store. It will show up in the UI as " App Store". \ No newline at end of file