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

OPDS guides #17

Merged
merged 1 commit into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/FAQs/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "FAQs",
"position": 6,
"position": 7,
"link": {
"type": "generated-index",
"description": "This is a list of frequently asked questions. Don't hesitate to ask new ones!"
Expand Down
15 changes: 0 additions & 15 deletions docs/import-content/opds.md

This file was deleted.

8 changes: 8 additions & 0 deletions docs/opds/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "OPDS: Your own server",
"position": 5,
"link": {
"type": "generated-index",
"description": "Here you will find guides to connect Panels to your OPDS server"
}
}
61 changes: 61 additions & 0 deletions docs/opds/kavita.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
sidebar_position: 3
---

# Kavita

This guide will walk you through the process of connecting Panels to your [Kavita](https://www.kavitareader.com/) instance.

## Adding your Kavita server to Panels

An OPDS feed is added to Panels as an importing service. From that point, it can be used either as a new library or just to download titles to your own device library.

To add a new OPDS feed, open Panels and go to Library -> Connect Service -> OPDS.

<img src ="/img/kavita-setup/01.png" style={{maxHeight: '800px'}}/>

You'll be taken to the OPDS configuration screen.
Kavita offers an authorized URL, so you don't have to add any username or password.

To get the feed URL, go to your server Settings section, then open the "3td-Party Clients" and copy the OPDS URL.
<img src ="/img/kavita-setup/04.png" style={{maxHeight: '500px'}}/>
<img src ="/img/kavita-setup/05.png" style={{maxHeight: '500px'}}/>

Paste that URL in the "Host" field on Panels and save the configuration.

Specify the "Port" if your server is not using port 80 or 8080.

⚠️ And leave username and password **empty**.

<img src ="/img/kavita-setup/02.png" style={{maxHeight: '800px'}}/>

Your Kavita server should now appear both as a new library and as a new Import Service. Let's explore both options.

<img src ="/img/kavita-setup/03.png" style={{maxHeight: '800px'}}/>


## Kavita as Import Service

You can use this method if you plan to use your Kavita server mainly to import (download) comics into your device.

To add content to your library, you can follow either of these 2 flows:

1. From he content screen, tap your server, navigate and select the files you want to import, and last select where yo place them in your device library.

<img src ="/img/kavita-setup/06.png"/>

2. Navigate first to the location in your device library where you want your files to be imported. Then tap the 3 dot symbol and select "Import Files". Choose your server and find the files you want to download to your phone.

<img src ="/img/kavita-setup/07.png"/>

From either of the above flows above, your download should start and be visible from the "Downloads" tab.

<img src ="/img/kavita-setup/08.png" style={{maxHeight: '800px'}}/>


## Kavita as a Library

Panels treats OPDS feeds as libraries. That means you can navigate your server library as if it was on your own device, with the benefit of keeping all files stored somewhere else.
Once you find a title you want to read, you can tap to open and start reading it (stream) or you can choose to download it for offline use. Long press a title (or select many) to show all options.

<img src ="/img/kavita-setup/09.png"/>
50 changes: 50 additions & 0 deletions docs/opds/komga.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
sidebar_position: 2
---

# Komga

This guide will walk you through the process of connecting Panels to your [Komga](https://komga.org/) instance.

## Adding your Komga server to Panels

An OPDS feed is added to Panels as an importing service. From that point, it can be used either as a new library or just to download titles to your own device library.

To add a new OPDS feed, open Panels and go to Library -> Connect Service -> OPDS.

<img src ="/img/komga-setup/01.png" style={{maxHeight: '800px'}}/>

You'll be taken to the OPDS configuration screen. Give any name to your server, then enter your _server address_, _username_, and _password_. Tap on _Apply_.

<img src ="/img/komga-setup/02.png" style={{maxHeight: '800px'}}/>

Your Komga server should now appear both as a new library and as a new Import Service. Let's explore both options.

<img src ="/img/komga-setup/03.png" style={{maxHeight: '800px'}}/>


## Komga as Import Service

You can use this method if you plan to use your Komga server mainly to import (download) comics into your device.

To add content to your library, you can follow either of these 2 flows:

1. From he content screen, tap your server, navigate and select the files you want to import, and last select where yo place them in your device library.

<img src ="/img/komga-setup/04.png"/>

2. Navigate first to the location in your device library where you want your files to be imported. Then tap the 3 dot symbol and select "Import Files". Choose your server and find the files you want to download to your phone.

<img src ="/img/komga-setup/05.png"/>

From either of the above flows above, your download should start and be visible from the "Downloads" tab.

<img src ="/img/komga-setup/06.png" style={{maxHeight: '800px'}}/>


## Komga as a Library

Panels treats OPDS feeds as libraries. That means you can navigate your server library as if it was on your own device, with the benefit of keeping all files stored somewhere else.
Once you find a title you want to read, you can tap to open and start reading it (stream) or you can choose to download it for offline use. Long press a title (or select many) to show all options.

<img src ="/img/komga-setup/07.png"/>
16 changes: 16 additions & 0 deletions docs/opds/opds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_position: 1
---

# What is OPDS

[OPDS](https://opds.io) is a standard for content distribution. Most popular comic servers have adopted OPDS to allow third-party apps to access their content.

If you have a large comic collection or you just don't want your files to take out too much space in your device, you can choose to [have your content stored on iCloud Drive](/import-content/icloud-drive) or have it stored in your own server.

Panels can connect to server using the OPDS standard. There are multiple server implementations compatible with OPDS.
For comics in particular, we do recommend using [Kavita](https://www.kavitareader.com/), [Komga](https://komga.org/) or [Codex](https://github.com/ajslater/codex).

Each one of those servers offer great documentation and communities around them, so we strongly suggest you visit them to set your server up.

You can also check out the guides we've written for some of the most popular comic servers.
Binary file added static/img/kavita-setup/01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/kavita-setup/02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/kavita-setup/03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/kavita-setup/04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/kavita-setup/05.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/kavita-setup/06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/kavita-setup/07.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/kavita-setup/08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/kavita-setup/09.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/komga-setup/01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/komga-setup/02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/komga-setup/03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/komga-setup/04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/komga-setup/05.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/komga-setup/06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/komga-setup/07.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading