Merge pull request #106 from meienberger/feature/app-store

📦 Feature - App Store

.dockerignore

@@ -0,0 +1,6 @@
+**/node_modules
+**/.next
+/node_modules
+/.next
+node_modules
+.next

.github/workflows/ci.yml

@@ -42,10 +42,22 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
+      - name: Build packages/common
+        run: |
+          cd ./packages/common
+          npm run build
+          cd ../..
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build packages
+        run: pnpm -r build
+
       - name: Run global tests
         run: pnpm test
 
-      - name: Run tests
+      - name: Run linter
         run: pnpm -r lint
       
       - name: Run tests

.github/workflows/release-candidate.yml

@@ -61,22 +61,13 @@ jobs:
       - name: Build and push dashboard
         uses: docker/build-push-action@v3
         with:
-          context: ./packages/dashboard
+          context: .
           platforms: linux/amd64,linux/arm64,linux/arm/v7
           push: true
-          tags: meienberger/tipi-dashboard:rc-${{ steps.meta.outputs.TAG }}
-          cache-from: type=registry,ref=meienberger/tipi-dashboard:buildcache
-          cache-to: type=registry,ref=meienberger/tipi-dashboard:buildcache,mode=max
-      
-      - name: Build and push api
-        uses: docker/build-push-action@v3
-        with:
-          context: ./packages/system-api
-          platforms: linux/amd64,linux/arm64,linux/arm/v7
-          push: true
-          tags: meienberger/tipi-api:rc-${{ steps.meta.outputs.TAG }}
-          cache-from: type=registry,ref=meienberger/tipi-api:buildcache
-          cache-to: type=registry,ref=meienberger/tipi-api:buildcache,mode=max
+          tags: meienberger/runtipi:rc-${{ steps.meta.outputs.TAG }}
+          cache-from: type=registry,ref=meienberger/runtipi:buildcache
+          cache-to: type=registry,ref=meienberger/runtipi:buildcache,mode=max
+    
 
   # Test installation script
   # test-install:

.github/workflows/release.yml

@@ -62,16 +62,6 @@ jobs:
           context: ./packages/dashboard
           platforms: linux/amd64,linux/arm64,linux/arm/v7
           push: true
-          tags: meienberger/tipi-dashboard:latest,meienberger/tipi-dashboard:${{ steps.meta.outputs.TAG }}
-          cache-from: type=registry,ref=meienberger/tipi-dashboard:buildcache
-          cache-to: type=registry,ref=meienberger/tipi-dashboard:buildcache,mode=max
-      
-      - name: Build and push api
-        uses: docker/build-push-action@v3
-        with:
-          context: ./packages/system-api
-          platforms: linux/amd64,linux/arm64,linux/arm/v7
-          push: true
-          tags: meienberger/tipi-api:latest,meienberger/tipi-api:${{ steps.meta.outputs.TAG }}
-          cache-from: type=registry,ref=meienberger/tipi-api:buildcache
-          cache-to: type=registry,ref=meienberger/tipi-api:buildcache,mode=max
+          tags: meienberger/runtipi:latest,meienberger/runtipi:${{ steps.meta.outputs.TAG }}
+          cache-from: type=registry,ref=meienberger/runtipi:buildcache
+          cache-to: type=registry,ref=meienberger/runtipi:buildcache,mode=max

.gitignore

@@ -25,3 +25,4 @@ media/torrents/incomplete/*
 !media/torrents/incomplete/.gitkeep
 media/torrents/watch/*
 !media/torrents/watch/.gitkeep
+packages/dashboard/package-lock.json

packages/system-api/Dockerfile.dev → Dockerfile

@@ -1,7 +1,24 @@
+FROM node:18-buster-slim AS build
+
+COPY ./packages/common /common
+
+WORKDIR /api
+COPY ./packages/system-api/package.json /api/package.json
+RUN npm i
+COPY ./packages/system-api /api
+RUN npm run build
+
+WORKDIR /dashboard
+COPY ./packages/dashboard/package.json /dashboard/package.json
+RUN npm i
+COPY ./packages/dashboard /dashboard
+RUN npm run build
+
+
 FROM ubuntu:20.04
 ARG DEBIAN_FRONTEND=noninteractive
 
-WORKDIR /app
+WORKDIR /
 
 # Install docker
 RUN apt-get update && apt-get install -y \
@@ -22,15 +39,23 @@ RUN apt-get install -y docker-ce docker-ce-cli containerd.io
 # Install node
 RUN curl -sL https://deb.nodesource.com/setup_18.x | bash -
 RUN apt-get install -y nodejs
+RUN npm install --quiet node-gyp -g
 
 # Install docker-compose
 RUN curl -L "https://github.com/docker/compose/releases/download/v2.5.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
 RUN chmod +x /usr/local/bin/docker-compose
 
-COPY ./package.json ./
+COPY ./packages/common /common
+
+WORKDIR /api
+COPY ./packages/system-api/package.json /api/package.json
+RUN npm install --omit=dev
 
-RUN npm install
+WORKDIR /dashboard
+COPY ./packages/dashboard/package.json /dashboard/package.json
+RUN npm install --omit=dev
 
-COPY ./ ./
+COPY --from=build /api /api
+COPY --from=build /dashboard /dashboard
 
-CMD ["npm", "run", "dev"]
+WORKDIR /

packages/system-api/Dockerfile → Dockerfile.dev

@@ -1,7 +1,7 @@
 FROM ubuntu:20.04
 ARG DEBIAN_FRONTEND=noninteractive
 
-WORKDIR /app
+WORKDIR /
 
 # Install docker
 RUN apt-get update && apt-get install -y \
@@ -10,9 +10,6 @@ RUN apt-get update && apt-get install -y \
     gnupg \
     lsb-release
 
-RUN apt-get install -y \
-    g++ gcc make python
-
 RUN curl -fsSL https://download.docker.com/linux/ubuntu/gpg | gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
 
 RUN echo \
@@ -25,18 +22,22 @@ RUN apt-get install -y docker-ce docker-ce-cli containerd.io
 # Install node
 RUN curl -sL https://deb.nodesource.com/setup_18.x | bash -
 RUN apt-get install -y nodejs
-RUN npm install --quiet node-gyp -g
 
 # Install docker-compose
 RUN curl -L "https://github.com/docker/compose/releases/download/v2.5.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
 RUN chmod +x /usr/local/bin/docker-compose
 
-COPY ./package.json ./
+COPY ./packages/common /common
 
+WORKDIR /api
+COPY ./packages/system-api/package.json /api/package.json
 RUN npm install
 
-COPY ./ ./
+WORKDIR /dashboard
+COPY ./packages/dashboard/package.json /dashboard/package.json
+RUN npm install
 
-RUN npm run build
+COPY ./packages/system-api /api
+COPY ./packages/dashboard /dashboard
 
-CMD ["npm", "run", "start"]
+WORKDIR /

README.md

@@ -5,14 +5,14 @@
 [![License](https://img.shields.io/github/license/meienberger/runtipi)](https://github.com/meienberger/runtipi/blob/master/LICENSE)
 [![Version](https://img.shields.io/github/v/release/meienberger/runtipi?color=%235351FB&label=version)](https://github.com/meienberger/runtipi/releases)
 ![Issues](https://img.shields.io/github/issues/meienberger/runtipi)
-[![Docker Pulls](https://badgen.net/docker/pulls/meienberger/tipi-dashboard?icon=docker&label=pulls)](https://hub.docker.com/r/meienberger/tipi-dashboard/)
-[![Docker Image Size](https://badgen.net/docker/size/meienberger/tipi-dashboard?icon=docker&label=image%20size)](https://hub.docker.com/r/meienberger/tipi-dashboard/)
+[![Docker Pulls](https://badgen.net/docker/pulls/meienberger/runtipi?icon=docker&label=pulls)](https://hub.docker.com/r/meienberger/tipi-dashboard/)
+[![Docker Image Size](https://badgen.net/docker/size/meienberger/runtipi?icon=docker&label=image%20size)](https://hub.docker.com/r/meienberger/tipi-dashboard/)
 ![Build](https://github.com/meienberger/runtipi/workflows/Tipi%20CI/badge.svg)
 #### Join the discussion
 [![Discord](https://img.shields.io/discord/976934649643294750?label=discord&logo=discord)](https://discord.gg/Bu9qEPnHsc)
 [![Matrix](https://img.shields.io/matrix/runtipi:matrix.org?label=matrix&logo=matrix)](https://matrix.to/#/#runtipi:matrix.org)
 
-![Preview](https://raw.githubusercontent.com/meienberger/runtipi/develop/screenshots/1.png)
+![Preview](https://raw.githubusercontent.com/meienberger/runtipi/develop/screenshots/appstore.png)
 > ⚠️ Tipi is still at an early stage of development and issues are to be expected. Feel free to open an issue or pull request if you find a bug.
 
 Tipi is a personal homeserver orchestrator. It is running docker containers under the hood and provides a simple web interface to manage them. Every service comes with an opinionated configuration in order to remove the need for manual configuration and network setup.
@@ -95,6 +95,7 @@ Tipi is licensed under the GNU General Public License v3.0. TL;DR — You may co
 - [Matrix](https://matrix.to/#/#runtipi:matrix.org)<br />
 - [Twitter](https://twitter.com/runtipi)
 - [Telegram](https://t.me/+72-y10MnLBw2ZGI0)
+- [Discord](https://discord.gg/Bu9qEPnHsc)
 
 ## Contributors ✨
 
@@ -114,4 +115,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

ansible/ansible.cfg

@@ -1,2 +0,0 @@
-[defaults]
-INVENTORY = hosts

ansible/host_vars/tipi.yml

@@ -1,4 +0,0 @@
-packages:
-  - jq
-  - coreutils
-  - docker

ansible/hosts

@@ -1,2 +0,0 @@
-[localhost]
-tipi ansible_connection=local

ansible/setup.yml

@@ -1,9 +0,0 @@
----
-- hosts: tipi
-  become: yes
-
-  tasks:
-    - import_tasks: ./tasks/common/essential.yml
-    - import_tasks: ./tasks/common/docker.yml
-    # - name: Reboot machine
-    #   reboot:

ansible/stop.yml

@@ -1,6 +0,0 @@
----
-- hosts: tipi
-  become: yes
-
-  tasks:
-    - import_tasks: ./tasks/common/teardown.yml

ansible/tasks/common/docker.yml

@@ -1,67 +0,0 @@
-- name: Install docker
-  package:
-    name:
-      - docker
-      - ca-certificates
-      - curl
-      - gnupg
-      - lsb-release
-    state: latest
-
-- name: Check lsb_release -cs
-  shell: lsb_release -is
-  register: lsb_release
-
-- name: Add docker gpg key (Ubuntu)
-  shell: curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
-  when: lsb_release.stdout == 'Ubuntu'
-
-- name: Add docker gpg key (Debian)
-  shell: curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
-  when: lsb_release.stdout == 'Debian'
-
-- name: Add deb repo for docker (Ubuntu)
-  shell: echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
-  when: lsb_release.stdout == 'Ubuntu'
-
-- name: Add deb repo for docker (Debian)
-  shell: echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian $(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
-  when: lsb_release.stdout == 'Debian'
-
-- name: Update packages
-  apt:
-    update_cache: yes
-    upgrade: yes
-
-- name: Install essential packages
-  package:
-    name:
-      - docker-ce
-      - docker-ce-cli
-      - containerd.io
-    state: latest
-
-- name: Check if docker-compose is installed
-  stat:
-    path: /usr/local/bin/docker-compose
-  register: docker_compose_status
-
-- name: Install docker-compose
-  shell: 'curl -L "https://github.com/docker/compose/releases/download/v2.3.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose'
-  when: not docker_compose_status.stat.exists
-
-- name: Make docker-compose executable
-  shell: chmod +x /usr/local/bin/docker-compose
-
-- name: Create group docker
-  group:
-    name: docker
-
-- name: Put user in docker group
-  shell: usermod -aG docker {{ username }}
-
-- name: Start docker service
-  service:
-    enabled: yes
-    name: docker
-    state: started

ansible/tasks/common/essential.yml

@@ -1,33 +0,0 @@
-- name: Update packages
-  apt:
-    update_cache: yes
-    upgrade: yes
-
-- name: Install essential packages
-  package:
-    name: "{{ packages }}"
-    state: latest
-
-- name: Upgrade packages
-  apt:
-    upgrade: yes
-
-- name: Add user to root group
-  user:
-    name: "{{ username }}"
-    group: root
-
-- name: "Enable passwordless sudo for {{ username }}"
-  lineinfile:
-    dest: /etc/sudoers
-    regexp: "^%wheel"
-    line: "{{ username }} ALL=(ALL) NOPASSWD: ALL"
-    validate: "/usr/sbin/visudo -cf %s"
-
-- name: Create cron every minute running system-info.sh
-  cron:
-    name: "system-info"
-    user: "{{ username }}"
-    minute: "*/1"
-    job: "{{ playbook_dir }}/../scripts/system-info.sh"
-  ignore_errors: yes

ansible/tasks/common/teardown.yml

@@ -1,18 +0,0 @@
-- name: Check if pm2 is installed
-  become_user: "{{ username }}"
-  stat:
-    path: /usr/local/bin/pm2
-  register: pm2_status
-
-- name: Check if app is already running
-  become_user: "{{ username }}"
-  shell: pm2 list
-  register: pm2_result
-  when: pm2_status.stat.exists
-
-- name: Stop app
-  become_user: "{{ username }}"
-  shell: pm2 stop "system-api"
-  when:
-    - pm2_status.stat.exists
-    - pm2_result.stdout.find("system-api") != -1

ansible/tasks/network/avahi.yml

@@ -1,44 +0,0 @@
-# Network
-- name: Install avahi
-  package:
-    name: avahi
-    state: latest
-  when: ansible_os_family == "Arch"
-
-- name: Install avahi
-  package:
-    name: avahi-daemon
-    state: latest
-  when: ansible_os_family == "Debian"
-
-- name: Disable and stop sytemd-resolved
-  service:
-    name: systemd-resolved
-    state: stopped
-    enabled: no
-
-- name: Replace line in /etc/nsswitch.conf
-  lineinfile:
-    path: /etc/nsswitch.conf
-    regexp: '^hosts:.*'
-    line: 'hosts: mymachines mdns_minimal [NOTFOUND=return] resolve [!UNAVAIL=return] files myhostname dns'
-
-- name: Allow port 5353 in UFW
-  community.general.ufw:
-    rule: allow
-    port: 5353
-    proto: udp
-
-- name: Copy avahi template to /etc/avahi/services/tipi.service
-  copy:
-    src: "{{ playbook_dir }}/templates/avahi/tipi.service"
-    dest: /etc/avahi/services/tipi.service
-    group: avahi
-    owner: avahi
-
-- name: Start and enable avahi-daemon
-  service:
-    name: avahi-daemon
-    state: restarted
-    enabled: yes
-###

ansible/templates/avahi/tipi.service

@@ -1,16 +0,0 @@
-<?xml version="1.0" standalone='no'?><!--*-nxml-*-->
-<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
-<service-group>
-  <name replace-wildcards="yes">%h</name>
-  <service>
-    <type>_http._tcp</type>
-    <port>80</port>
-  </service>
-</service-group>
-<!-- <service-group>
-  <name replace-wildcards="yes">%h</name>
-  <service>
-    <type>_http._tcp</type>
-    <port>443</port>
-  </service>
-</service-group> -->

apps/__tests__/apps.test.ts

@@ -58,6 +58,22 @@ describe("App configs", () => {
     });
   });
 
+  it("Each app should have a md description", () => {
+    const apps = getAppConfigs();
+
+    apps.forEach((app) => {
+      const path = `./apps/${app.id}/metadata/description.md`;
+
+      if (fs.existsSync(path)) {
+        const description = fs.readFileSync(path).toString();
+        expect(description).toBeDefined();
+      } else {
+        console.error(`Missing description for app ${app.id}`);
+        expect(true).toBe(false);
+      }
+    });
+  });
+
   it("Each app should have a name", () => {
     const apps = getAppConfigs();
 

apps/adguard/config.json

@@ -3,12 +3,12 @@
   "available": true,
   "port": 8104,
   "id": "adguard",
+  "categories": ["network", "security"],
   "description": "Adguard is the best way to get rid of annoying ads and online tracking and protect your computer from malware. Make your web surfing fast, safe and ad-free.",
   "short_desc": "World's most advanced adblocker!",
-  "author": "ArneNaessens",
+  "author": "AdguardTeam",
   "source": "https://github.com/AdguardTeam",
-  "image": "https://avatars.githubusercontent.com/u/8361145?s=200&v=4",
-  "cagegories": ["network", "security"],
+  "image": "/logos/apps/adguard.jpg",
   "requirements": {
     "ports": [53]
   },

apps/adguard/docker-compose.yml

@@ -2,7 +2,7 @@
 version: "3.7"
 services:
   adguard:
-    image: adguard/adguardhome:v0.107.6
+    image: adguard/adguardhome:v0.107.7
     container_name: adguard
     volumes:
       - "${APP_DATA_DIR}/data/work:/opt/adguardhome/work"

apps/adguard/metadata/description.md

@@ -1,3 +1,6 @@
-Network-wide ads & trackers blocking DNS server
+## AdGuard Home is a network-wide software for blocking ads & tracking.
 
-AdGuard Home is a network-wide software for blocking ads and tracking. After you set it up, it'll cover all your home devices, and you won't need any client-side software for that. Learn more on our official Github repository.
+After you set it up, it'll cover ALL your home devices, and you don't need any client-side software for that.
+It operates as a DNS server that re-routes tracking domains to a "black hole", thus preventing your devices from connecting to those servers. It's based on software we use for our public AdGuard DNS servers -- both share a lot of common code.
+
+![Screenshot](https://cdn.adguard.com/public/Adguard/Common/adguard_home.gif)

apps/calibre-web/config.json

@@ -3,10 +3,11 @@
   "available": true,
   "port": 8100,
   "id": "calibre-web",
+  "categories": ["books"],
   "description": "On the initial setup screen, enter /books as your calibre library location. \n Default admin login: Username: admin Password: admin123",
   "short_desc": "Calibre-web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.",
   "author": "https://github.com/janeczku/",
   "source": "https://github.com/janeczku/calibre-web",
-  "image": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/calibre-web-icon.png",
+  "image": "/logos/apps/calibre-web.jpg",
   "form_fields": {}
 }

apps/calibre-web/metadata/description.md

@@ -0,0 +1,7 @@
+Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using a valid Calibre database.
+
+On the initial setup screen, enter /books as your calibre library location.
+
+- **username**: admin
+- **password**: admin123
+<br />

apps/code-server/config.json

@@ -3,6 +3,7 @@
   "available": true,
   "port": 8101,
   "id": "code-server",
+  "categories": ["development"],
   "description": "",
   "short_desc": "Code-server is VS Code running on a remote server, accessible through the browser.",
   "author": "https://github.com/coder",

apps/code-server/metadata/description.md

@@ -0,0 +1,7 @@
+## Run VS Code on any machine anywhere and access it in the browser.
+
+- Code on any device with a consistent development environment
+- Use cloud servers to speed up tests, compilations, downloads, and more
+- Preserve battery life when you're on the go; all intensive tasks run on your server
+
+![screenshot](https://raw.githubusercontent.com/coder/code-server/main/docs/assets/screenshot.png)

apps/filebrowser/config.json

@@ -3,11 +3,12 @@
   "available": true,
   "port": 8096,
   "id": "filebrowser",
+  "categories": ["utilities"],
   "description": "Reliable and Performant File Management Desktop Sync and File Sharing\n Default credentials: admin / admin",
   "short_desc": "Access your homeserver files from your browser",
-  "author": "",
+  "author": "filebrowser.org",
   "website": "https://filebrowser.org/",
   "source": "https://github.com/filebrowser/filebrowser",
-  "image": "https://avatars.githubusercontent.com/u/35781395?s=200&v=4",
+  "image": "/logos/apps/filebrowser.jpg",
   "form_fields": {}
 }

apps/filebrowser/metadata/description.md

@@ -0,0 +1,12 @@
+## Access your homeserver files from your browser
+
+filebrowser provides a file managing interface within a specified directory and it can be used to upload, delete, preview, rename and edit your files. It allows the creation of multiple users and each user can have its own directory. It can be used as a standalone app.
+
+- **username**: admin
+- **password**: admin
+<br />
+## Features
+
+Please refer to our docs at [https://filebrowser.org/features](https://filebrowser.org/features)
+
+![Preview](https://user-images.githubusercontent.com/5447088/50716739-ebd26700-107a-11e9-9817-14230c53efd2.gif)

apps/freshrss/config.json

@@ -3,10 +3,11 @@
   "available": true,
   "port": 8086,
   "id": "freshrss",
+  "categories": ["utilities"],
   "description": "FreshRSS is a self-hosted RSS feed aggregator like Leed or Kriss Feed.\nIt is lightweight, easy to work with, powerful, and customizable.\n\nIt is a multi-user application with an anonymous reading mode. It supports custom tags. There is an API for (mobile) clients, and a Command-Line Interface.\n\nThanks to the WebSub standard (formerly PubSubHubbub), FreshRSS is able to receive instant push notifications from compatible sources, such as Mastodon, Friendica, WordPress, Blogger, FeedBurner, etc.\n\nFreshRSS natively supports basic Web scraping, based on XPath, for Web sites not providing any RSS / Atom feed.\n\nFinally, it supports extensions for further tuning.",
   "short_desc": "A free, self-hostable aggregator… ",
   "author": "https://freshrss.org/",
   "source": "https://github.com/FreshRSS/FreshRSS",
-  "image": "https://avatars.githubusercontent.com/u/9414285?s=200&v=4",
+  "image": "/logos/apps/freshrss.jpg",
   "form_fields": {}
 }

apps/freshrss/metadata/description.md

@@ -0,0 +1,27 @@
+
+
+## A free, self-hostable aggregator… 
+
+FreshRSS is a self-hosted RSS feed aggregator like [Leed](https://github.com/LeedRSS/Leed) or [Kriss Feed](https://tontof.net/kriss/feed/).
+
+It is lightweight, easy to work with, powerful, and customizable.
+
+It is a multi-user application with an anonymous reading mode. It supports custom tags.
+There is an API for (mobile) clients, and a [Command-Line Interface](cli/README.md).
+
+Thanks to the [WebSub](https://www.w3.org/TR/websub/) standard (formerly [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub)),
+FreshRSS is able to receive instant push notifications from compatible sources, such as [Mastodon](https://joinmastodon.org), [Friendica](https://friendi.ca), [WordPress](https://wordpress.org/plugins/pubsubhubbub/), Blogger, FeedBurner, etc.
+
+FreshRSS natively supports basic Web scraping, based on [XPath](https://www.w3.org/TR/xpath-10/), for Web sites not providing any RSS / Atom feed.
+
+Finally, it supports [extensions](#extensions) for further tuning.
+
+Feature requests, bug reports, and other contributions are welcome. The best way to contribute is to [open an issue on GitHub](https://github.com/FreshRSS/FreshRSS/issues).
+We are a friendly community.
+
+* Official website: [website](https://freshrss.org)
+* Demo: [Demo](https://demo.freshrss.org/)
+* License: [GNU AGPL 3](https://www.gnu.org/licenses/agpl-3.0.html)
+
+![Screenshot](https://raw.githubusercontent.com/FreshRSS/FreshRSS/edge/docs/img/FreshRSS-screenshot.png)
+

apps/gitea/config.json

@@ -3,10 +3,11 @@
   "port": 8108,
   "available": true,
   "id": "gitea",
+  "categories": ["development"],
   "description": "Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, and GitLab. Gitea is a fork of Gogs. See the Gitea Announcement blog post to read about the justification for a fork.",
   "short_desc": "Gitea - Git with a cup of tea · A painless self-hosted Git service. · Cross-platform · Easy to install · Lightweight · Open Source.",
   "author": "go-gitea",
   "source": "https://github.com/go-gitea/gitea",
-  "image": "https://avatars.githubusercontent.com/u/12724356?s=200&v=4",
+  "image": "/logos/apps/gitea.jpg",
   "form_fields": {}
 }

apps/gitea/metadata/description.md

@@ -0,0 +1,5 @@
+# A painless self-hosted Git service
+
+The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. Using Go, this can be done with an independent binary distribution across all platforms which Go supports, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. Want to try it before doing anything else? Do it with the online demo! This project has been forked from Gogs since 2016.11 but changed a lot.
+
+![Screenshot](https://camo.githubusercontent.com/134f49a62801ab393c211125515d108439c67b59befb2ec3e42e7235af4f5d6c/68747470733a2f2f646c2e67697465612e696f2f73637265656e73686f74732f686f6d655f74696d656c696e652e706e67)

apps/homarr/config.json

@@ -3,11 +3,12 @@
   "available": true,
   "port": 8102,
   "id": "homarr",
+  "categories": ["utilities"],
   "description": "A homepage for your server.",
   "short_desc": "Homarr is a simple and lightweight homepage for your server, that helps you easily access all of your services in one place.",
   "author": "ajnart",
   "source": "https://github.com/ajnart/homarr",
   "website": "https://discord.gg/C2WTXkzkwK",
-  "image": "https://raw.githubusercontent.com/ajnart/homarr/master/public/imgs/logo.png",
+  "image": "/logos/apps/homarr.jpg",
   "form_fields": {}
 }

apps/homarr/metadata/description.md

@@ -0,0 +1,10 @@
+# Lightweight homepage for your server
+Homarr is a simple and lightweight homepage for your server, that helps you easily access all of your services in one place.
+It integrates with the services you use to display information on the homepage (E.g. Show upcoming Sonarr/Radarr releases).
+
+If you have any questions about Homarr or want to share information with us, please go to one of the following places:
+
+- [Github Discussions](https://github.com/ajnart/homarr/discussions)
+- [Discord Server](https://discord.gg/aCsmEV5RgA)
+
+![Screenshot](https://user-images.githubusercontent.com/71191962/169860380-856634fb-4f41-47cb-ba54-6a9e7b3b9c81.gif)

apps/homeassistant/config.json

@@ -3,10 +3,11 @@
   "available": true,
   "port": 8123,
   "id": "homeassistant",
+  "categories": ["automation"],
   "description": "Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.",
   "short_desc": "Open source home automation that puts local control and privacy first",
   "author": "ArneNaessens",
   "source": "https://github.com/home-assistant/core",
-  "image": "https://avatars.githubusercontent.com/u/13844975?s=200&v=4",
+  "image": "/logos/apps/homeassistant.jpg",
   "form_fields": {}
 }

apps/homeassistant/metadata/description.md

@@ -0,0 +1,7 @@
+
+## Open source home automation that puts local control and privacy first
+
+Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.
+Check out [home-assistant.io](https://home-assistant.io) for a [demo](https://home-assistant.io/demo/), installation [instructions](https://home-assistant.io/getting-started/), [tutorials](https://home-assistant.io/getting-started/automation/) and [documentation](https://home-assistant.io/docs/)
+
+![Screenshot](https://raw.githubusercontent.com/home-assistant/core/master/docs/screenshots.png)

apps/invidious/config.json

@@ -3,6 +3,7 @@
   "available": true,
   "port": 8095,
   "id": "invidious",
+  "categories": ["media", "social"],
   "description": "Invidious is an open source alternative front-end to YouTube.",
   "short_desc": "An alternative front-end to YouTube",
   "author": "iv-org",

apps/invidious/docker-compose.arm.yml

@@ -43,3 +43,5 @@ services:
       POSTGRES_PASSWORD: tipi
     healthcheck:
       test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
+    networks:
+      - tipi_main_network

apps/invidious/docker-compose.yml

@@ -44,3 +44,5 @@ services:
       POSTGRES_PASSWORD: tipi
     healthcheck:
       test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
+    networks:
+      - tipi_main_network

apps/invidious/metadata/description.md

@@ -0,0 +1,27 @@
+
+## An open source alternative front-end to YouTube
+
+**User features**
+- Lightweight
+- No ads
+- No tracking
+- No JavaScript required
+- Light/Dark themes
+- Customizable homepage
+- Subscriptions independent from Google
+- Notifications for all subscribed channels
+- Audio-only mode (with background play on mobile)
+- Support for Reddit comments
+- Available in many languages, thanks to our translators
+<br />
+**Data import/export**
+- Import subscriptions from YouTube, NewPipe and Freetube
+- Import watch history from NewPipe
+- Export subscriptions to NewPipe and Freetube
+- Import/Export Invidious user data
+<br />
+**Technical features**
+- Embedded video support
+- [Developer API](https://docs.invidious.io/api/)
+- Does not use official YouTube APIs
+- No Contributor License Agreement (CLA)

apps/jackett/config.json

@@ -5,8 +5,9 @@
   "id": "jackett",
   "description": "Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar3, Lidarr, DuckieTV, qBittorrent, Nefarious etc.) into tracker-site-specific http queries, parses the html or json response, and then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches.",
   "short_desc": "API Support for your favorite torrent trackers ",
+  "categories": ["media", "utilities"],
   "author": "",
   "source": "https://github.com/Jackett/Jackett",
-  "image": "https://avatars.githubusercontent.com/u/15383019?s=200&v=4",
+  "image": "/logos/apps/jackett.jpg",
   "form_fields": {}
 }

apps/jackett/metadata/description.md

@@ -0,0 +1,5 @@
+## API Support for your favorite torrent trackers
+
+Jackett works as a proxy server: it translates queries from apps ([Sonarr](https://github.com/Sonarr/Sonarr), [Radarr](https://github.com/Radarr/Radarr), [SickRage](https://sickrage.github.io/), [CouchPotato](https://couchpota.to/), [Mylar3](https://github.com/mylar3/mylar3), [Lidarr](https://github.com/lidarr/lidarr), [DuckieTV](https://github.com/SchizoDuckie/DuckieTV), [qBittorrent](https://www.qbittorrent.org/), [Nefarious](https://github.com/lardbit/nefarious) etc.) into tracker-site-specific http queries, parses the html or json response, and then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.
+
+![Screenshot](https://raw.githubusercontent.com/Jackett/Jackett/master/.github/jackett-screenshot1.png)

apps/jellyfin/config.json

@@ -3,6 +3,7 @@
   "available": true,
   "port": 8091,
   "id": "jellyfin",
+  "categories": ["media"],
   "description": "Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!",
   "short_desc": "A media server for your home collection",
   "author": "jellyfin.org",

apps/jellyfin/metadata/description.md

@@ -0,0 +1,5 @@
+## A media server for your home collection
+
+Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!
+
+For further details, please see [our documentation page](https://docs.jellyfin.org/). To receive the latest updates, get help with Jellyfin, and join the community, please visit [one of our communication channels](https://docs.jellyfin.org/general/getting-help.html). For more information about the project, please see our [about page](https://docs.jellyfin.org/general/about.html).

apps/joplin/config.json

@@ -3,11 +3,12 @@
   "available": true,
   "port": 8099,
   "id": "joplin",
+  "categories": ["utilities"],
   "description": "Default credentials: admin@localhost / admin",
   "short_desc": "Note taking and to-do application with synchronisation",
   "author": "https://github.com/laurent22",
   "source": "https://github.com/laurent22/joplin",
   "website": "https://joplinapp.org",
-  "image": "https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/LinuxIcons/256x256.png",
+  "image": "/logos/apps/joplin.jpg",
   "form_fields": {}
 }

apps/joplin/metadata/description.md

@@ -0,0 +1,17 @@
+## Note taking and to-do application with synchronisation
+
+- **username**: admin@localhost
+- **password**: admin
+<br />
+
+Joplin is a free, open source note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified either from the applications directly or from your own text editor. The notes are in Markdown format.
+
+Notes exported from Evernote can be imported into Joplin, including the formatted content (which is converted to Markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.). Plain Markdown files can also be imported.
+
+The notes can be securely synchronised using end-to-end encryption with various cloud services including Nextcloud, Dropbox, OneDrive and Joplin Cloud.
+
+Full text search is available on all platforms to quickly find the information you need. The app can be customised using plugins and themes, and you can also easily create your own.
+
+The application is available for Windows, Linux, macOS, Android and iOS. A Web Clipper, to save web pages and screenshots from your browser, is also available for Firefox and Chrome.
+
+![Screenshot](https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/home-top-img.png)

apps/libreddit/config.json

@@ -3,10 +3,11 @@
   "available": true,
   "port": 8105,
   "id": "libreddit",
+  "categories": ["social"],
   "description": "LibReddit is a bloat free reddit frontend written in Rust, no ads, no tracking and strong Content Security Policy prevents any request from going to reddit, everything is proxied.",
   "short_desc": "Browse reddit without problems!",
   "author": "spikecodes",
   "source": "https://github.com/spikecodes/libreddit",
-  "image": "https://raw.githubusercontent.com/spikecodes/libreddit/master/static/logo.png",
+  "image": "/logos/apps/libreddit.jpg",
   "form_fields": {}
 }

apps/libreddit/metadata/description.md

@@ -0,0 +1,12 @@
+## An alternative private front-end to Reddit
+
+
+**10 second pitch:** Libreddit is a portmanteau of "libre" (meaning freedom) and "Reddit". It is a private front-end like [Invidious](https://github.com/iv-org/invidious) but for Reddit. Browse the coldest takes of [r/unpopularopinion](https://libreddit.spike.codes/r/unpopularopinion) without being [tracked](#reddit).
+
+- 🚀 Fast: written in Rust for blazing-fast speeds and memory safety
+- ☁️ Light: no JavaScript, no ads, no tracking, no bloat
+- 🕵 Private: all requests are proxied through the server, including media
+- 🔒 Secure: strong [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) prevents browser requests to Reddit
+<br />
+
+![Screenshot](https://camo.githubusercontent.com/0753860e104fd86d32e13d47b31c8db88ec86bbdc66911480d92d20a96332c51/68747470733a2f2f692e6962622e636f2f515962715451742f6c69627265646469742d727573742e706e67)

apps/n8n/config.json

@@ -3,11 +3,12 @@
   "available": true,
   "port": 8094,
   "id": "n8n",
+  "categories": ["automation"],
   "description": "n8n is an extendable workflow automation tool. With a fair-code distribution model, n8n will always have visible source code, be available to self-host, and allow you to add your own custom functions, logic and apps. n8n's node-based approach makes it highly versatile, enabling you to connect anything to everything.",
   "short_desc": "Workflow Automation Tool. Alternative to Zapier",
   "author": "n8n.io",
   "source": "https://github.com/n8n-io/n8n",
   "website": "https://n8n.io/",
-  "image": "https://avatars.githubusercontent.com/u/45487711?s=200&v=4",
+  "image": "/logos/apps/n8n.jpg",
   "form_fields": {}
 }

apps/n8n/metadata/description.md

@@ -0,0 +1,6 @@
+## Easily automate tasks across different services. 
+
+n8n is an extendable workflow automation tool. With a fair-code distribution model, n8n will always have visible source code, be available to self-host, and allow you to add your own custom functions, logic and apps. n8n's node-based approach makes it highly 
+versatile, enabling you to connect anything to everything.
+
+![Screenshot](https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-screenshot.png)

apps/nextcloud/config.json

@@ -3,6 +3,7 @@
   "available": true,
   "port": 8083,
   "id": "nextcloud",
+  "categories": ["data"],
   "description": "Nextcloud is a self-hosted, open source, and fully-featured cloud storage solution for your personal files, office documents, and photos.",
   "short_desc": "Productivity platform that keeps you in control",
   "author": "Nextcloud GmbH",

apps/nextcloud/metadata/description.md

@@ -0,0 +1,29 @@
+## A safe home for all your data.
+
+* 📁 **Access your Data** You can store your files, contacts, calendars and more on a server of your choosing.
+* 🔄 **Sync your Data** You keep your files, contacts, calendars and more synchronized amongst your devices.
+* 🙌 **Share your Data** …by giving others access to the stuff you want them to see or to collaborate with.
+* 🚀 **Expandable with hundreds of Apps** ...like [Calendar](https://github.com/nextcloud/calendar), [Contacts](https://github.com/nextcloud/contacts), [Mail](https://github.com/nextcloud/mail), [Video Chat](https://github.com/nextcloud/spreed) and all those you can discover in our [App Store](https://apps.nextcloud.com)
+* 🔒 **Security** with our encryption mechanisms, [HackerOne bounty program](https://hackerone.com/nextcloud) and two-factor authentication.
+
+You want to learn more about how you can use Nextcloud to access, share and protect your files, calendars, contacts, communication & more at home and at your organization? [**Learn about all our Features**](https://nextcloud.com/athome/).
+
+## Get your Nextcloud 🚚
+
+- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) at one of our providers either through our website or through the apps directly.
+- 🖥 [**Install** a server by yourself](https://nextcloud.com/install/#instructions-server) on your own hardware or by using one of our ready to use **appliances**
+- 📦 Buy one of the [awesome **devices** coming with a preinstalled Nextcloud](https://nextcloud.com/devices/)
+- 🏢 Find a [service **provider**](https://nextcloud.com/providers/) who hosts Nextcloud for you or your company
+
+Enterprise? Public Sector or Education user? You may want to have a look into [**Nextcloud Enterprise**](https://nextcloud.com/enterprise/) provided by Nextcloud GmbH.
+
+## Get in touch 💬
+
+* [📋 Forum](https://help.nextcloud.com)
+* [👥 Facebook](https://www.facebook.com/nextclouders)
+* [🐣 Twitter](https://twitter.com/Nextclouders)
+* [🐘 Mastodon](https://mastodon.xyz/@nextcloud)
+
+You can also [get support for Nextcloud](https://nextcloud.com/support)!
+
+![](https://raw.githubusercontent.com/nextcloud/screenshots/master/files/Files%20Sharing.png)

apps/nitter/config.json

@@ -3,10 +3,11 @@
   "available": true,
   "port": 8106,
   "id": "nitter",
+  "categories": ["social"],
   "description": "A free and open source alternative Twitter front-end focused on privacy and performance.",
   "short_desc": "Twitter without annoyances!",
   "author": "zedeus",
   "source": "https://github.com/zedeus/nitter",
-  "image": "https://raw.githubusercontent.com/zedeus/nitter/master/public/favicon.ico",
+  "image": "/logos/apps/nitter.jpg",
   "form_fields": {}
 }

apps/nitter/metadata/description.md

@@ -0,0 +1,16 @@
+## Alternative Twitter front-end 
+
+A free and open source alternative Twitter front-end focused on privacy and performance. Inspired by the [Invidious](https://github.com/iv-org/invidious) project.
+
+- No JavaScript or ads
+- All requests go through the backend, client never talks to Twitter
+- Prevents Twitter from tracking your IP or JavaScript fingerprint
+- Uses Twitter's unofficial API (no rate limits or developer account required)
+- Lightweight (for [@nim_lang](https://nitter.net/nim_lang), 60KB vs 784KB from twitter.com)
+- RSS feeds
+- Themes
+- Mobile support (responsive design)
+- AGPLv3 licensed, no proprietary instances permitted
+<br />
+
+![Screenshot](https://raw.githubusercontent.com/zedeus/nitter/master/screenshot.png)

apps/nodered/config.json

@@ -3,6 +3,7 @@
   "port": 8111,
   "available": true,
   "id": "nodered",
+  "categories": ["automation"],
   "description": "Node-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways. It provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single-click.",
   "short_desc": "Low-code programming for event-driven applications",
   "author": "node-red",

apps/nodered/metadata/description.md

@@ -0,0 +1,6 @@
+## Low-code programming for event-driven applications.
+
+Node-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways.
+It provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single-click.
+
+![Screenshot](https://camo.githubusercontent.com/c7b6e0b937295c4d2c852130814050eb0caffac5b700ead6de21df6dbf83aa82/687474703a2f2f6e6f64657265642e6f72672f696d616765732f6e6f64652d7265642d73637265656e73686f742e706e67)

apps/photoprism/config.json

@@ -3,11 +3,12 @@
   "port": 8110,
   "available": true,
   "id": "photoprism",
+  "categories": ["photography"],
   "description": "PhotoPrism® is an AI-Powered Photos App for the Decentralized Web. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud. Default username: admin",
   "short_desc": "AI-Powered Photos App for the Decentralized Web. We are on a mission to protect your freedom and privacy.",
   "author": "PhotoPrism",
   "source": "https://github.com/photoprism/photoprism",
-  "image": "https://avatars.githubusercontent.com/u/32436079?s=200&v=4",
+  "image": "/logos/apps/photoprism.jpg",
   "form_fields": {
     "password": {
       "type": "password",

apps/photoprism/metadata/description.md

@@ -0,0 +1,9 @@
+## AI-Powered Photos App for the Decentralized Web 🌈💎✨ 
+
+- **username**: admin
+<br />
+
+PhotoPrism® is an AI-Powered Photos App for the Decentralized Web. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud.
+To get a first impression, you are welcome to play with our [public demo](https://try.photoprism.app/). Be careful not to upload any private pictures.
+
+![Screenshot](https://camo.githubusercontent.com/5e03a87e47aad26ad7248b8b43eac6471fe96f7b655ac2e532697692753c3ff8/68747470733a2f2f646c2e70686f746f707269736d2e6170702f696d672f75692f6465736b746f702d3130303070782e6a7067)

apps/pihole/config.json

@@ -6,11 +6,12 @@
     "ports": [53]
   },
   "id": "pihole",
+  "categories": ["network", "security"],
   "description": "The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content without installing any client-side software.",
   "short_desc": "A black hole for Internet advertisements",
   "author": "pi-hole.net",
   "source": "https://github.com/pi-hole/pi-hole",
-  "image": "https://avatars.githubusercontent.com/u/16827203?s=200&v=4",
+  "image": "/logos/apps/pihole.jpg",
   "form_fields": {
     "password": {
       "type": "password",

apps/pihole/metadata/description.md

@@ -0,0 +1,14 @@
+## A black hole for Internet advertisements
+
+The Pi-hole® is a [DNS sinkhole](https://en.wikipedia.org/wiki/DNS_Sinkhole) that protects your devices from unwanted content without installing any client-side software.
+
+- **Easy-to-install**: our versatile installer walks you through the process and takes less than ten minutes
+- **Resolute**: content is blocked in _non-browser locations_, such as ad-laden mobile apps and smart TVs
+- **Responsive**: seamlessly speeds up the feel of everyday browsing by caching DNS queries
+- **Lightweight**: runs smoothly with [minimal hardware and software requirements](https://docs.pi-hole.net/main/prerequisites/)
+- **Robust**: a command line interface that is quality assured for interoperability
+- **Insightful**: a beautiful responsive Web Interface dashboard to view and control your Pi-hole
+- **Versatile**: can optionally function as a [DHCP server](https://discourse.pi-hole.net/t/how-do-i-use-pi-holes-built-in-dhcp-server-and-why-would-i-want-to/3026), ensuring *all* your devices are protected automatically
+- **Scalable**: [capable of handling hundreds of millions of queries](https://pi-hole.net/2017/05/24/how-much-traffic-can-pi-hole-handle/) when installed on server-grade hardware
+- **Modern**: blocks ads over both IPv4 and IPv6
+- **Free**: open source software that helps ensure _you_ are the sole person in control of your privacy

apps/prowlarr/config.json

@@ -3,10 +3,11 @@
   "available": true,
   "port": 8109,
   "id": "prowlarr",
+  "categories": ["media", "utilities"],
   "description": "Prowlarr is an indexer manager/proxy built on the popular *arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports management of both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Lidarr, Mylar3, Radarr, Readarr, and Sonarr offering complete management of your indexers with no per app Indexer setup required (we do it all).",
   "short_desc": "A torrent/usenet indexer manager/proxy",
   "author": "Prowlarr",
   "source": "https://github.com/Prowlarr/Prowlarr/",
-  "image": "https://prowlarr.com/logo/256.png",
+  "image": "/logos/apps/prowlarr.jpg",
   "form_fields": {}
 }

apps/prowlarr/metadata/description.md

@@ -0,0 +1,18 @@
+## A torrent/usenet indexer manager/proxy
+
+Prowlarr is an indexer manager/proxy built on the popular *arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports management of both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Lidarr, Mylar3, Radarr, Readarr, and Sonarr offering complete management of your indexers with no per app Indexer setup required (we do it all).
+
+### Major Features Include
+
+- Usenet support for 24 indexers natively, including Headphones VIP
+- Usenet support for any Newznab compatible indexer via "Generic Newznab"
+- Torrent support for over 500 trackers with more added all the time
+- Torrent support for any Torznab compatible tracker via "Generic Torznab"
+- Support for custom YML definitions via Cardigann that includes JSON and XML parsing
+- Indexer Sync to Lidarr/Mylar3/Radarr/Readarr/Sonarr, so no manual configuration of the other applications are required
+- Indexer history and statistics
+- Manual searching of Trackers & Indexers at a category level
+- Parameter based manual searching
+- Support for pushing multiple releases at once directly to your download clients from Prowlarr
+- Indexer health and status notifications
+- Per Indexer proxy support (SOCKS4, SOCKS5, HTTP, Flaresolverr)

apps/radarr/config.json

@@ -3,10 +3,11 @@
   "available": true,
   "port": 8088,
   "id": "radarr",
+  "categories": ["media", "utilities"],
   "description": "Radarr is a movie collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new movies and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available. Note that only one type of a given movie is supported. If you want both an 4k version and 1080p version of a given movie you will need multiple instances.",
   "short_desc": "Movie collection manager for Usenet and BitTorrent users.",
   "author": "radarr.video",
   "source": "https://github.com/Radarr/Radarr",
-  "image": "https://avatars.githubusercontent.com/u/25025331?s=200&v=4",
+  "image": "/logos/apps/radarr.jpg",
   "form_fields": {}
 }

apps/radarr/metadata/description.md

@@ -0,0 +1,23 @@
+## A fork of Sonarr to work with movies à la Couchpotato. 
+
+Radarr is a movie collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new movies and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available. Note that only one type of a given movie is supported. If you want both an 4k version and 1080p version of a given movie you will need multiple instances.
+
+### Major Features Include
+
+* Adding new movies with lots of information, such as trailers, ratings, etc.
+* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
+* Can watch for better quality of the movies you have and do an automatic upgrade. *e.g. from DVD to Blu-Ray*
+* Automatic failed download handling will try another release if one fails
+* Manual search so you can pick any release or to see why a release was not downloaded automatically
+* Full integration with SABnzbd and NZBGet
+* Automatically searching for releases as well as RSS Sync
+* Automatically importing downloaded movies
+* Recognizing Special Editions, Director's Cut, etc.
+* Identifying releases with hardcoded subs
+* Identifying releases with AKA movie names
+* SABnzbd, NZBGet, QBittorrent, Deluge, rTorrent, Transmission, uTorrent, and other download clients are supported and integrated
+* Full integration with Kodi and Plex (notifications, library updates)
+* Importing Metadata such as trailers or subtitles
+* Adding metadata such as posters and information for Kodi and others to use
+* Advanced customization for profiles, such that Radarr will always download the copy you want
+* A beautiful UI

apps/sonarr/config.json

@@ -3,10 +3,11 @@
   "available": true,
   "port": 8098,
   "id": "sonarr",
+  "categories": ["media", "utilities"],
   "description": "Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.",
   "short_desc": "TV show manager for Usenet and BitTorrent",
   "author": "sonarr.tv",
   "source": "https://github.com/Sonarr/Sonarr",
-  "image": "https://avatars.githubusercontent.com/u/1082903?s=200&v=4",
+  "image": "/logos/apps/sonarr.jpg",
   "form_fields": {}
 }

apps/sonarr/metadata/description.md

@@ -0,0 +1,17 @@
+## Smart PVR for newsgroup and bittorrent users. 
+
+Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
+
+### Current Features
+
+- Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
+- Automatically detects new episodes
+- Can scan your existing library and download any missing episodes
+- Can watch for better quality of the episodes you already have and do an automatic upgrade. *eg. from DVD to Blu-Ray*
+- Automatic failed download handling will try another release if one fails
+- Manual search so you can pick any release or to see why a release was not downloaded automatically
+- Fully configurable episode renaming
+- Full integration with SABnzbd and NZBGet
+- Full integration with Kodi, Plex (notification, library update, metadata)
+- Full support for specials and multi-episode releases
+- And a beautiful UI

apps/syncthing/config.json

@@ -3,11 +3,12 @@
   "available": true,
   "port": 8090,
   "id": "syncthing",
+  "categories": ["data", "utilities"],
   "description": "Syncthing is a peer-to-peer continuous file synchronization program. It synchronizes files between two or more computers in real time, safely protected from prying eyes. Your data is your data alone and you deserve to choose where it is stored, whether it is shared with some third party, and how it's transmitted over the internet.\n\nInstall the Syncthing app on your Umbrel and pair it with the Syncthing app on your phone or computer for a self hosted peer-to-peer backup solution.",
   "short_desc": "Peer-to-peer file synchronization between your devices",
   "author": "The Syncthing Foundation",
   "source": "https://github.com/syncthing",
   "website": "https://syncthing.net",
-  "image": "https://avatars.githubusercontent.com/u/7628018?s=200&v=4",
+  "image": "/logos/apps/syncthing.jpg",
   "form_fields": {}
 }

apps/syncthing/metadata/description.md

@@ -0,0 +1,38 @@
+## Peer-to-peer file synchronization between your devices
+
+Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers. We strive to fulfill the goals below. The goals are listed in order of importance, the most important one being the first. This is the summary version of the goal list - for more commentary, see the full Goals document.
+
+1. **Safe From Data Loss**
+
+   Protecting the user's data is paramount. We take every reasonable
+   precaution to avoid corrupting the user's files.
+
+2. **Secure Against Attackers**
+
+   Again, protecting the user's data is paramount. Regardless of our other
+   goals we must never allow the user's data to be susceptible to
+   eavesdropping or modification by unauthorized parties.
+
+3. **Easy to Use**
+
+   Syncthing should be approachable, understandable and inclusive.
+
+4. **Automatic**
+
+   User interaction should be required only when absolutely necessary.
+
+5. **Universally Available**
+
+   Syncthing should run on every common computer. We are mindful that the
+   latest technology is not always available to any given individual.
+
+6. **For Individuals**
+
+   Syncthing is primarily about empowering the individual user with safe,
+   secure and easy to use file synchronization.
+
+7. **Everything Else**
+
+   There are many things we care about that don't make it on to the list. It
+   is fine to optimize for these values, as long as they are not in conflict
+   with the stated goals above.

apps/tailscale/config.json

@@ -3,6 +3,7 @@
   "available": true,
   "port": 8093,
   "id": "tailscale",
+  "categories": ["network", "security"],
   "description": "Zero config VPN. Installs on any device in minutes, manages firewall rules for you, and works from anywhere.",
   "short_desc": "The easiest, most secure way to use WireGuard and 2FA.",
   "author": "© Tailscale Inc.",

apps/tailscale/metadata/description.md

@@ -0,0 +1,7 @@
+## The easiest, most secure way to use WireGuard and 2FA. 
+
+Zero config VPN. Installs on any device in minutes, manages firewall rules for you, and works from anywhere.
+Create a secure network between your servers, computers, and cloud instances. Even when separated by firewalls or subnets, Tailscale just works.
+Devices only connect after signing in through your existing identity provider. Easily enforce multi-factor authentication, deauthorize employees who’ve moved on, and more.
+
+![Screenshot](https://tailscale.com/static/images/marketing/home-illustration-2080w.webp)

apps/tautulli/config.json

@@ -3,10 +3,11 @@
   "available": true,
   "port": 8181,
   "id": "tautulli",
+  "categories": ["media", "utilities"],
   "description": "Tautulli is a 3rd party application that you can run alongside your Plex Media Server to monitor activity and track various statistics. Most importantly, these statistics include what has been watched, who watched it, when and where they watched it, and how it was watched. The only thing missing is \"why they watched it\", but who am I to question your 42 plays of Frozen. All statistics are presented in a nice and clean interface with many tables and graphs, which makes it easy to brag about your server to everyone else.",
-  "short_desc": "A Python based monitoring and tracking tool for Plex Media Server.",
+  "short_desc": "Monitoring and tracking tool for Plex Media Server.",
   "author": "JonnyWong16",
   "source": "https://github.com/Tautulli/Tautulli",
-  "image": "https://tautulli.com/images/logo-circle.png",
+  "image": "/logos/apps/tautulli.jpg",
   "form_fields": {}
 }

apps/tautulli/metadata/description.md

@@ -0,0 +1,19 @@
+## A Python based monitoring and tracking tool for Plex Media Server. 
+
+-   Responsive web design viewable on desktop, tablet and mobile web browsers.
+-   Themed to complement Plex/Web.
+-   Easy configuration setup (no separate web server required).
+-   Monitor current Plex Media Server activity.
+-   Fully customizable notifications for stream activity and recently added media.
+-   Top statistics on home page with configurable duration and measurement metric.
+-   Global watching history with search/filtering & dynamic column sorting.
+-   Full user list with general information and comparison stats.
+-   Individual user information including devices IP addresses.
+-   Complete library statistics and media file information.
+-   Rich analytics presented using Highcharts graphing.
+-   Beautiful content information pages.
+-   Full sync list data on all users syncing items from your library.
+-   And many more!!
+<br />
+
+![Screenshot](https://camo.githubusercontent.com/8e79a14ca41c16c2b1390fd3b3d686e90d5f1aaf2b466327f20d03fd123156cc/68747470733a2f2f74617574756c6c692e636f6d2f696d616765732f73637265656e73686f74732f61637469766974792d636f6d707265737365642e6a70673f763d32)

apps/transmission/config.json

@@ -6,6 +6,7 @@
     "ports": [51413]
   },
   "id": "transmission",
+  "categories": ["utilities"],
   "description": "Transmission is a fast, easy, and free BitTorrent client.",
   "short_desc": "Fast, easy, and free BitTorrent client",
   "author": "Transmission Project",

apps/transmission/metadata/description.md

@@ -0,0 +1,9 @@
+## Fast, easy, and free BitTorrent client
+
+Transmission is a fast, easy, and free BitTorrent client. It comes in several flavors:
+  * A native macOS GUI application
+  * GTK+ and Qt GUI applications for Linux, BSD, etc.
+  * A headless daemon for servers and routers
+  * A web UI for remote controlling any of the above
+
+Visit [https://transmissionbt.com/](https://transmissionbt.com/) for more information.

apps/vaultwarden/config.json

@@ -3,11 +3,12 @@
   "available": true,
   "port": 8107,
   "id": "vaultwarden",
+  "categories": ["utilities"],
   "description": "Alternative implementation of the Bitwarden server API written in Rust and compatible with upstream Bitwarden clients, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.",
   "short_desc": "All your passwords in your control!",
   "author": "Daniel García",
   "source": "https://github.com/dani-garcia/vaultwarden",
-  "image": "https://raw.githubusercontent.com/dani-garcia/vaultwarden/b636d20c6475bfb1b36561cb95812faee26ea7db/resources/vaultwarden-icon.svg",
+  "image": "/logos/apps/vaultwarden.jpg",
   "form_fields": {
     "admin_password": {
       "type": "password",

apps/vaultwarden/metadata/description.md

@@ -0,0 +1,13 @@
+## All your passwords in your control!
+
+Alternative implementation of the Bitwarden server API written in Rust and compatible with [upstream Bitwarden clients](https://bitwarden.com/download/), perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.
+
+Basically full implementation of Bitwarden API is provided including:
+
+ * Organizations support
+ * Attachments
+ * Vault API support
+ * Serving the static files for Vault interface
+ * Website icons API
+ * Authenticator and U2F support
+ * YubiKey and Duo support

apps/wg-easy/config.json

@@ -6,11 +6,12 @@
     "ports": [51820]
   },
   "id": "wg-easy",
+  "categories": ["network"],
   "description": "Access your homeserver from anywhere even on your mobile device. Wireguard-easy is a simple tool to configure and manage Wireguard VPN servers. It is written in Go and uses the official Wireguard client. You have to open and redirect port 51820 to your homeserver in order to connect.",
   "short_desc": "VPN server for your homeserver",
   "author": "WeeJeWel",
   "source": "https://github.com/WeeJeWel/wg-easy/",
-  "image": "https://avatars.githubusercontent.com/u/13991055?s=200&v=4",
+  "image": "/logos/apps/wireguard.jpg",
   "form_fields": {
     "host": {
       "type": "fqdnip",

apps/wg-easy/metadata/description.md

@@ -0,0 +1,14 @@
+## The easiest way to run WireGuard VPN + Web-based Admin UI.
+
+You have found the easiest way to install & manage WireGuard on any Linux host!
+
+* All-in-one: WireGuard + Web UI.
+* Easy installation, simple to use.
+* List, create, edit, delete, enable & disable clients.
+* Show a client's QR code.
+* Download a client's configuration file.
+* Statistics for which clients are connected.
+* Tx/Rx charts for each connected client.
+* Gravatar support.
+
+![Screenshot](https://raw.githubusercontent.com/WeeJeWel/wg-easy/master/assets/screenshot.png)

docker-compose.dev.yml

@@ -3,8 +3,9 @@ version: "3.7"
 services:
   api:
     build:
-      context: ./packages/system-api
+      context: .
       dockerfile: Dockerfile.dev
+    command: bash -c "cd /api && npm run dev"
     container_name: api
     ports:
       - 3001:3001
@@ -12,8 +13,8 @@ services:
       ## Docker sock
       - /var/run/docker.sock:/var/run/docker.sock:ro
       - ${PWD}:/tipi
-      - ${PWD}/packages/system-api:/app
-      - /app/node_modules
+      - ${PWD}/packages/system-api:/api
+      - /api/node_modules
     environment:
       - INTERNAL_IP=${INTERNAL_IP}
       - TIPI_VERSION=${TIPI_VERSION}
@@ -25,8 +26,9 @@ services:
 
   dashboard:
     build:
-      context: ./packages/dashboard
+      context: .
       dockerfile: Dockerfile.dev
+    command: bash -c "cd /dashboard && npm run dev"
     container_name: dashboard
     ports:
       - 3000:3000
@@ -35,8 +37,9 @@ services:
     environment:
       - INTERNAL_IP=${INTERNAL_IP}
     volumes:
-      - ${PWD}/packages/dashboard:/app
-      - /app/node_modules
+      - ${PWD}/packages/dashboard:/dashboard
+      - /dashboard/node_modules
+      - /dashboard/.next
     labels:
       traefik.enable: true
       traefik.http.routers.dashboard.rule: PathPrefix("/") # Host(`tipi.local`) &&

docker-compose.yml

@@ -16,7 +16,8 @@ services:
       - tipi_main_network
 
   api:
-    image: meienberger/tipi-api:${TIPI_VERSION}
+    image: meienberger/runtipi:${TIPI_VERSION}
+    command: bash -c "cd /api && npm run start"
     restart: unless-stopped
     container_name: api
     ports:
@@ -35,7 +36,8 @@ services:
       - tipi_main_network
 
   dashboard:
-    image: meienberger/tipi-dashboard:${TIPI_VERSION}
+    image: meienberger/runtipi:${TIPI_VERSION}
+    command: bash -c "cd /dasboard && npm run start"
     restart: unless-stopped
     container_name: dashboard
     ports:

package.json

@@ -9,7 +9,8 @@
     "act:docker": "act --container-architecture linux/amd64 --secret-file github.secrets -j build-images",
     "start:dev": "docker-compose -f docker-compose.dev.yml --env-file .env.dev up --build",
     "start:rc": "docker-compose -f docker-compose.rc.yml --env-file .env up --build",
-    "start:prod": "docker-compose --env-file .env up --build"
+    "start:prod": "docker-compose --env-file .env up --build",
+    "build:common": "cd packages/common && npm run build"
   },
   "devDependencies": {
     "@types/jest": "^27.5.0",
@@ -30,5 +31,6 @@
   "bugs": {
     "url": "https://github.com/meienberger/runtipi/issues"
   },
-  "homepage": "https://github.com/meienberger/runtipi#readme"
+  "homepage": "https://github.com/meienberger/runtipi#readme",
+  "dependencies": {}
 }

packages/common/.eslintignore

@@ -0,0 +1,4 @@
+node_modules/
+dist/
+*.cjs
+dist/

packages/common/.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  env: { node: true, jest: true },
+  extends: ['airbnb-typescript', 'eslint:recommended', 'plugin:import/typescript'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint', 'import', 'react'],
+  rules: {
+    'arrow-body-style': 0,
+    'no-restricted-exports': 0,
+    'max-len': [1, { code: 200 }],
+    'import/extensions': ['error', 'ignorePackages', { js: 'never', jsx: 'never', ts: 'never', tsx: 'never' }],
+  },
+};

packages/common/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+coverage/

packages/common/.npmignore

@@ -0,0 +1 @@
+

packages/common/.prettierrc.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+  singleQuote: true,
+  semi: true,
+  trailingComma: 'all',
+  printWidth: 200,
+};

packages/common/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@runtipi/common",
+  "version": "0.2.8",
+  "main": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "jest --coverage --passWithNoTests",
+    "build": "tsc -b tsconfig.build.json"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "esbuild": "^0.14.38",
+    "typescript": "4.6.4"
+  },
+  "dependencies": {},
+  "description": "",
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/common/src/constants/app.constants.ts

@@ -0,0 +1,16 @@
+import { AppCategoriesEnum } from '../types';
+
+// Icons should come from FontAwesome https://react-icons.github.io/react-icons/icons?name=fa
+export const APP_CATEGORIES = [
+  { name: 'Network', id: AppCategoriesEnum.NETWORK, icon: 'FaNetworkWired' },
+  { name: 'Media', id: AppCategoriesEnum.MEDIA, icon: 'FaVideo' },
+  { name: 'Development', id: AppCategoriesEnum.DEVELOPMENT, icon: 'FaCode' },
+  { name: 'Automation', id: AppCategoriesEnum.AUTOMATION, icon: 'FaRobot' },
+  { name: 'Social', id: AppCategoriesEnum.SOCIAL, icon: 'FaUserFriends' },
+  { name: 'Utilities', id: AppCategoriesEnum.UTILITIES, icon: 'FaWrench' },
+  { name: 'Photography', id: AppCategoriesEnum.PHOTOGRAPHY, icon: 'FaCamera' },
+  { name: 'Security', id: AppCategoriesEnum.SECURITY, icon: 'FaShieldAlt' },
+  { name: 'Featured', id: AppCategoriesEnum.FEATURED, icon: 'FaStar' },
+  { name: 'Books', id: AppCategoriesEnum.BOOKS, icon: 'FaBook' },
+  { name: 'Data', id: AppCategoriesEnum.DATA, icon: 'FaDatabase' },
+];

packages/common/src/constants/index.ts

@@ -0,0 +1 @@
+export * from './app.constants';

packages/common/src/index.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './constants';

packages/common/src/types/app.types.ts

@@ -0,0 +1,63 @@
+export enum AppCategoriesEnum {
+  NETWORK = 'network',
+  MEDIA = 'media',
+  DEVELOPMENT = 'development',
+  AUTOMATION = 'automation',
+  SOCIAL = 'social',
+  UTILITIES = 'utilities',
+  PHOTOGRAPHY = 'photography',
+  SECURITY = 'security',
+  FEATURED = 'featured',
+  BOOKS = 'books',
+  DATA = 'data',
+}
+
+export enum FieldTypes {
+  text = 'text',
+  password = 'password',
+  email = 'email',
+  number = 'number',
+  fqdn = 'fqdn',
+  ip = 'ip',
+  fqdnip = 'fqdnip',
+  url = 'url',
+}
+
+interface FormField {
+  type: FieldTypes;
+  label: string;
+  max?: number;
+  min?: number;
+  hint?: string;
+  required?: boolean;
+  env_variable: string;
+}
+
+export enum AppStatusEnum {
+  RUNNING = 'running',
+  STOPPED = 'stopped',
+  INSTALLING = 'installing',
+  UNINSTALLING = 'uninstalling',
+  STOPPING = 'stopping',
+  STARTING = 'starting',
+}
+
+export interface AppConfig {
+  id: string;
+  available: boolean;
+  port: number;
+  name: string;
+  requirements?: {
+    ports?: number[];
+  };
+  description: string;
+  version: string;
+  image: string;
+  form_fields: Record<string, FormField>;
+  short_desc: string;
+  author: string;
+  source: string;
+  installed: boolean;
+  categories: AppCategoriesEnum[];
+  status: AppStatusEnum;
+}

packages/common/src/types/index.ts

@@ -0,0 +1 @@
+export * from './app.types';

packages/common/tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["**/*.ts", "**/*.tsx"]
+}

packages/common/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": false,
+    "esModuleInterop": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": false,
+    "jsx": "preserve",
+    "incremental": false,
+    "declaration": true,
+    "outDir": "./dist"
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "**/*.cjs", "jest.config.cjs"],
+  "exclude": ["node_modules", "dist"]
+}

packages/dashboard/.dockerignore

@@ -1,2 +1,2 @@
 node_modules/
-.next/
+.next/

packages/dashboard/.eslintignore

@@ -1,3 +1,4 @@
 *.config.js
 .eslintrc.js
-next.config.js
+next.config.js
+jest.config.js