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

Update shiori.yml #973

Merged
merged 1 commit into from
Aug 1, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 53 additions & 20 deletions public/v4/apps/shiori.yml
Original file line number Diff line number Diff line change
@@ -1,40 +1,73 @@
captainVersion: 4

services:
# Shiori
$$cap_appname:
image: radhifadlillah/shiori@sha256:3d1eb1f0aeb9804dea41f3ec5d29de5cf214bb66ef04dce1aa942ca17caec7bb
image: ghcr.io/go-shiori/shiori:$$cap_shiori_version
environment:
SHIORI_DIR: /data
SHIORI_DBMS: mysql
SHIORI_MYSQL_USER: $$cap_mariadb-user
SHIORI_MYSQL_PASS: $$cap_mariadb-pass
SHIORI_MYSQL_NAME: $$cap_mariadb-db
SHIORI_MYSQL_ADDRESS: tcp(srv-captain--$$cap_appname-mariadb)
volumes:
- $$cap_appname-shiori-data:/data
restart: on-failure
- $$cap_appname-data:/shiori
restart: unless-stopped
kgnfth marked this conversation as resolved.
Show resolved Hide resolved
caproverExtra:
containerHttpPort: '8080'

# MariaDB
$$cap_appname-mariadb:
image: mariadb:$$cap_mariadb_version
environment:
MYSQL_RANDOM_ROOT_PASSWORD: '1'
MYSQL_DATABASE: $$cap_mariadb-db
MYSQL_USER: $$cap_mariadb-user
MYSQL_PASSWORD: $$cap_mariadb-pass
volumes:
- $$cap_appname-mariadb-data:/var/lib/mysql
restart: unless-stopped
caproverExtra:
notExposeAsWebApp: 'true'
caproverOneClickApp:
variables:
- id: $$cap_shiori_version
label: Shiori Version Tag
description: Check out their Docker page for the valid tags https://github.com/go-shiori/shiori/pkgs/container/shiori/versions?filters%5Bversion_type%5D=tagged
defaultValue: 'v1.5.5'
- id: $$cap_mariadb_version
label: MariaDB Version
defaultValue: '11.0.2'
description: Check out their docker page for the valid tags https://hub.docker.com/r/library/mariadb/tags/
validRegex: /^([^\s^\/])+$/
- id: $$cap_mariadb-db
label: MariaDB Database
description: Database name for Shiori
defaultValue: 'shiori'
- id: $$cap_mariadb-user
label: MariaDB User
description: Database User for Shiori
defaultValue: 'shiori'
- id: $$cap_mariadb-pass
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest using $$cap_gen_random_hex(16) as a default value for the ease of installation

label: MariaDB database user password
description: Super secret database user password
displayName: 'Shiori'
isOfficial: false
isOfficial: true
description: 'A simple bookmark manager built with Go.'
instructions:
start: >
This app stores its data in a SQLite database in a Docker volume.

Once deployed, this app will be accessible with a default username and
password. If this is a problem, you should deploy behind TLS and
basic-auth until you can log in and change them.

username: shiori

password: gopher
Shiori is a simple bookmarks manager written in the Go language. Intended as a simple clone of Pocket.
You can use it as a command line application or as a web application.
This application is distributed as a single binary, which means it can be installed and used easily.
end: >
Shiori is up and running.

You can log in with the username and password below to create and account
under `Settings`. Once you've created an account the default credentials
will be disabled.
Since this is our first time, we don't have any account registered yet. With that said, we can use the default user to access web interface

username: shiori

password: gopher

Once login succeed you will be able to use the web interface. To add the new account, open the settings page and add accounts as needed.
The first new account you add will become the owner and it will deactivate the "shiori:gopher" default user automatically.

Read more at: https://github.com/go-shiori/shiori/blob/master/docs/Usage.md#using-web-interface
documentation: >
From https://github.com/go-shiori/shiori.
Loading