Skip to content

Commit

Permalink
[App] Shiori: Simple bookmark manager
Browse files Browse the repository at this point in the history
- https://github.com/go-shiori/shiori

Signed-off-by: Avinal Kumar <avinal.xlvii@gmail.com>
  • Loading branch information
avinal committed Sep 5, 2024
1 parent bd1c1e6 commit 97bb77d
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 0 deletions.
22 changes: 22 additions & 0 deletions apps/shiori/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"$schema": "../schema.json",
"name": "Shiori",
"available": true,
"exposable": true,
"force_expose": true,
"port": 8207,
"id": "shiori",
"tipi_version": 1,
"version": "1.7.0",
"categories": [
"utilities"
],
"description": "Shiori is a simple bookmarks manager written in the Go language. Intended as a simple clone of Pocket.",
"short_desc": "Shlink is a self-hosted bookmark manager.",
"author": "Radhi Fadlillah",
"source": "https://github.com/go-shiori/shiori",
"supported_architectures": [
"arm64",
"amd64"
]
}
57 changes: 57 additions & 0 deletions apps/shiori/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
version: "3.9"
services:
shiori_db:
container_name: shiori-db
image: postgres:15
environment:
POSTGRES_PASSWORD: ${SHIORI_DB_PASSWORD}
POSTGRES_USER: tipi
POSTGRES_DB: shiori
volumes:
- ${APP_DATA_DIR}/data/db:/var/lib/postgresql/data
healthcheck:
test: ['CMD-SHELL', 'pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB']
interval: 5s
timeout: 5s
retries: 5
networks:
- tipi_main_network
labels:
runtipi.managed: true

shiori:
container_name: shiori
image:
restart: unless-stopped
ports:
- ${APP_PORT}:8080
networks:
- tipi_main_network
environment:
SHIORI_DATABASE_URL: "postgres://" # need help here
labels:
# Main
traefik.enable: true
traefik.http.middlewares.shlink-web-redirect.redirectscheme.scheme: https
traefik.http.services.shlink.loadbalancer.server.port: 8080
# Web
traefik.http.routers.shlink-insecure.rule: Host(`${APP_DOMAIN}`)
traefik.http.routers.shlink-insecure.entrypoints: web
traefik.http.routers.shlink-insecure.service: shiori
traefik.http.routers.shlink-insecure.middlewares: shiori-web-redirect
# Websecure
traefik.http.routers.shlink.rule: Host(`${APP_DOMAIN}`)
traefik.http.routers.shlink.entrypoints: websecure
traefik.http.routers.shlink.service: shiori
traefik.http.routers.shlink.tls.certresolver: myresolver
# Local domain
traefik.http.routers.shlink-local-insecure.rule: Host(`shlink.${LOCAL_DOMAIN}`)
traefik.http.routers.shlink-local-insecure.entrypoints: web
traefik.http.routers.shlink-local-insecure.service: shiori
traefik.http.routers.shlink-local-insecure.middlewares: shiori-web-redirect
# Local domain secure
traefik.http.routers.shlink-local.rule: Host(`shlink.${LOCAL_DOMAIN}`)
traefik.http.routers.shlink-local.entrypoints: websecure
traefik.http.routers.shlink-local.service: shiori
traefik.http.routers.shlink-local.tls: true
runtipi.managed: true
21 changes: 21 additions & 0 deletions apps/shiori/metadata/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Shiori

Shiori is a simple bookmarks manager written in the Go language. Intended as a simple clone of Pocket.

## Features

- Basic bookmarks management i.e. add, edit, delete and search.
- Import and export bookmarks from and to Netscape Bookmark file.
- Import bookmarks from Pocket.
- Simple and clean command line interface.
- Simple and pretty web interface for those who don't want to use a command line app.
- Portable, thanks to its single binary format.
- Support for sqlite3, PostgreSQL and MySQL as its database.
- Where possible, by default `shiori` will parse the readable content and create an offline archive of the webpage.
- [BETA] [web extension](https://github.com/go-shiori/shiori-web-ext) support for Firefox and Chrome.

## Screenshots

![Home Page](https://raw.githubusercontent.com/go-shiori/shiori/master/docs/readme/cover.png)

![Reader Mode](https://raw.githubusercontent.com/go-shiori/shiori/master/docs/readme/comparison.png)
Binary file added apps/shiori/metadata/logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 97bb77d

Please sign in to comment.