diff --git a/README.md b/README.md index 6d2c38831a5de7d9a0c07b2aa01a01df757c523c..b1fc1f7c914fb43382882f263f6a8425f345509d 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,12 @@ 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. ## Apps available +- [Calibre-Web](https://github.com/janeczku/calibre-web) - Web Ebook Reader +- [Code-Server](https://github.com/filebrowser/filebrowser) - Web VS Code - [Filebrowser](https://github.com/filebrowser/filebrowser) - Web File Browser - [Freshrss](https://github.com/FreshRSS/FreshRSS) - A free, self-hostable RSS aggregator - [Invidious](https://github.com/iv-org/invidious) - An alternative front-end to YouTube +- [Homarr](https://github.com/ajnart/homarr) - A homepage for your server. - [Jackett](https://github.com/Jackett/Jackett) - API Support for your favorite torrent trackers - [Jellyfin](https://github.com/jellyfin/jellyfin) - A media server for your home collection - [Joplin](https://github.com/laurent22/joplin) - Privacy focused note-taking app diff --git a/apps/calibre-web/config.json b/apps/calibre-web/config.json new file mode 100644 index 0000000000000000000000000000000000000000..6e19d314a096abe580e6c1d5d58ecd84daef6df6 --- /dev/null +++ b/apps/calibre-web/config.json @@ -0,0 +1,12 @@ +{ + "name": "Calibre-Web - EBook Reader", + "available": true, + "port": 8100, + "id": "calibre-web", + "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", + "form_fields": {} +} diff --git a/apps/calibre-web/data/books/metadata.db b/apps/calibre-web/data/books/metadata.db new file mode 100644 index 0000000000000000000000000000000000000000..c32a5867d017c11ffa0dae52f6d60634439c7c2d Binary files /dev/null and b/apps/calibre-web/data/books/metadata.db differ diff --git a/apps/calibre-web/docker-compose.yml b/apps/calibre-web/docker-compose.yml new file mode 100644 index 0000000000000000000000000000000000000000..5b6225fe6a08a642874e6a774c295ee8f33555c7 --- /dev/null +++ b/apps/calibre-web/docker-compose.yml @@ -0,0 +1,17 @@ +version: "2.1" +services: + calibre-web: + image: lscr.io/linuxserver/calibre-web:latest + container_name: calibre-web + environment: + - PUID=1000 + - PGID=1000 + - TZ=${TZ} + volumes: + - ${APP_DATA_DIR}/data/config:/config + - ${APP_DATA_DIR}/data/books:/books + ports: + - ${APP_PORT}:8083 + restart: unless-stopped + networks: + - tipi_main_network \ No newline at end of file diff --git a/apps/code-server/config.json b/apps/code-server/config.json new file mode 100644 index 0000000000000000000000000000000000000000..1f1063287b0b1b80ec2f28755fffc00900ca5009 --- /dev/null +++ b/apps/code-server/config.json @@ -0,0 +1,21 @@ +{ + "name": "Code-Server - Web VS Code", + "available": true, + "port": 8101, + "id": "code-server", + "description": "", + "short_desc": "Code-server is VS Code running on a remote server, accessible through the browser.", + "author": "https://github.com/coder", + "source": "https://github.com/linuxserver/docker-code-server", + "image": "https://avatars.githubusercontent.com/u/95932066", + "form_fields": { + "password": { + "type": "password", + "label": "Password", + "max": 50, + "min": 3, + "required": true, + "env_variable": "CODESERVER_PASSWORD" + } + } +} diff --git a/apps/code-server/docker-compose.yml b/apps/code-server/docker-compose.yml new file mode 100644 index 0000000000000000000000000000000000000000..d2d72b9e9bec2c40fc5c5d6d64c66490926fc692 --- /dev/null +++ b/apps/code-server/docker-compose.yml @@ -0,0 +1,19 @@ +version: "2.1" +services: + code-server: + image: lscr.io/linuxserver/code-server:latest + container_name: code-server + environment: + - PUID=1000 + - PGID=1000 + - TZ=${TZ} + - PASSWORD=${CODESERVER_PASSWORD} + - DEFAULT_WORKSPACE=/config/workspace #optional + volumes: + - ${APP_DATA_DIR}/data/config:/config #config dir + - ${APP_DATA_DIR}/data/projects:/projects + ports: + - ${APP_PORT}:8443 + restart: unless-stopped + networks: + - tipi_main_network \ No newline at end of file diff --git a/apps/homarr/config.json b/apps/homarr/config.json new file mode 100644 index 0000000000000000000000000000000000000000..8c7e97ce5435ef0be0b4b2a666e11958727252db --- /dev/null +++ b/apps/homarr/config.json @@ -0,0 +1,13 @@ +{ + "name": "Homarr", + "available": true, + "port": 8102, + "id": "homarr", + "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": "https://github.com/ajnart/", + "source": "https://github.com/ajnart/homar", + "website": "https://discord.gg/C2WTXkzkwK", + "image": "https://raw.githubusercontent.com/ajnart/homarr/master/public/imgs/logo.png", + "form_fields": {} +} diff --git a/apps/homarr/docker-compose.yml b/apps/homarr/docker-compose.yml new file mode 100644 index 0000000000000000000000000000000000000000..9f374ab7bc01788b55a2bdab01ddfc88b0443819 --- /dev/null +++ b/apps/homarr/docker-compose.yml @@ -0,0 +1,12 @@ +version: '3' +services: + homarr: + container_name: homarr + image: ghcr.io/ajnart/homarr:latest + restart: unless-stopped + volumes: + - ${APP_DATA_DIR}/data/config:/app/data/configs + ports: + - ${APP_PORT}:7575 + networks: + - tipi_main_network \ No newline at end of file diff --git a/packages/system-api/src/config/apps.ts b/packages/system-api/src/config/apps.ts index 755f5ad334a4790d80f326b67fc9e40a63c56d12..c5d005d7233822664e4842c78c01eddccbade0dd 100644 --- a/packages/system-api/src/config/apps.ts +++ b/packages/system-api/src/config/apps.ts @@ -15,4 +15,7 @@ export const appNames = [ 'n8n', 'invidious', 'joplin', + 'homarr', + 'code-server', + 'calibre-web', ];