-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from Produkt/more-guides
More guides
- Loading branch information
Showing
16 changed files
with
202 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,70 @@ | ||
--- | ||
sidebar_position: 1 | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Files app and iOS mechanisms | ||
|
||
Panels tries to be a good iOS platform citizen and is compatible with multiple iOS methods for importing methods. | ||
|
||
## Mac to iOS device | ||
|
||
If you have comics stored in your Mac you have a few options. | ||
|
||
### Web server | ||
|
||
Web Server option will start a server from your iOS device. Once the server is started, you can access that URL from your computer (as long as both devices are on the same wifi), and drop files there to send them to your iOS device. | ||
|
||
To start a session, go to Library -> back to content, then tap Web Server. After tapping "start server" a URL will be displayed. Use that URL on your mac browser. | ||
|
||
### Airdrop | ||
|
||
You can select multiple files and airdrop from your Mac to your iPhone (or between iOS devices). | ||
|
||
Airdrop changed recently on iOS 17 and it no longer asks with which app to open files, it puts them directly in Files app. Scroll down to [working with Files app](#files-app) to know how to move your content to Panels. | ||
|
||
### Cable | ||
|
||
Connect your iOS device to your Mac and open Finder. Your device should appear on the left panel, under Locations. | ||
|
||
![finder app showing panels content](/img/finder-panels-content.png) | ||
|
||
Select it, and navigate to Files. Scroll down the list of apps until you find Panels. Drag & drop your files to copy them to your device. Panels will show up the files once it finishes indexing the folder. | ||
|
||
Each folder represents a collection, you can drag folders containing other folders as well as individual comic files. Make sure to check [which files are supported](supported-files.md). | ||
|
||
:::tip | ||
|
||
If your iOS device free storage is low, consider [iCloud Drive](icloud-drive.md) or [storing content in your server](opds.md). | ||
|
||
::: | ||
|
||
## Content already in your device | ||
|
||
If your content is already in your iOS device (downloaded from Safari, contained in another app, etc.) you can use any iOS mechanism to bring content into Panels. | ||
|
||
The easiest way will probably be using [Files app](#files-app) which comes pre-installed in every iOS device. | ||
|
||
Otherwise, you can use "share" (usually represented with an arrow pointing up on a square) or Drag&Drop. Drag&Drop will be easier on an iPad, since you can put 2 apps side-by-side and just drag the content into Panels. On iPhone it is possible, you just need 2 hands (one to keep the content you are moving under your finger, the other to navigate to Panels). | ||
|
||
## Working with Files app {#files-app} | ||
|
||
Files app is like "finder" for iOS devices. Moving content in Files app is easy, you just need to locate the content you want to move and know where to drop it. | ||
|
||
First, locate your content. It might be in the Downloads folder, or in another app's folder if you are migrating from another reading app. | ||
|
||
Select one file by long pressing, or tap the "..." top right button and tap select to enable multi-selection. | ||
|
||
Once the content is selected, you can either copy or move. Copy will keep the content where it is, essentially duplicating it when you paste it, so be aware of storage. | ||
|
||
Now let's paste/move the content to Panels folder. Still inside Files app, go back until to root screen called Browse. Tap "on my iPhone/iPad" and find a folder called Panels (with the Panels logo). This is your main library root folder (what you see when you open Panels' main library). | ||
Panels represents folders as collections. You can use Files app to modify content, move, paste, etc. | ||
|
||
Find the collection you want and paste the content ("..." top right button, paste), or move it here. | ||
|
||
Panels will re-index the library to reflect those changes. | ||
|
||
:::tip | ||
|
||
You can have [more than one library](../organize-content/multiple-libraries.md). You can also have your library [synced with iCloud Drive](icloud-drive.md). | ||
|
||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,25 @@ | ||
--- | ||
sidebar_position: 3 | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Your content in the cloud | ||
# Synced content via iCloud Drive | ||
|
||
// iCloud drive | ||
In addition to [syncing your reading sessions](../misc/sync-reading-sessions.md), Panels can keep your content synced between devices. Panels has support for [multiple libraries](../organize-content/multiple-libraries.md) in addition to having the current device library. | ||
|
||
The trick to having your content synced via iCloud Drive is to choose a root library folder stored anywhere in iCloud Drive. | ||
|
||
To add an iCloud Drive library, head to the library tab, go back to "Content" and tap on the "..." icon, then choose "Add a new library". From the files app modal, navigate to any folder located inside your iCloud Drive folder. You can also create a new one if you don't have any comics in iCloud Drive yet. Choose the root folder and tap open. | ||
Panels will add that folder as a new library. From that point you will be able to navigate that folder within Panels, and use it as a regular library. | ||
Panels will not download any files to your device until you tap on them to read. | ||
|
||
:::note | ||
|
||
Panels needs to download each file once to extract the cover from it. Once extracted, the full comics will be deleted from you device and the cover will be placed in a folder and synced, so there is no need to download that file again until you read it. | ||
|
||
::: | ||
|
||
:::tip | ||
|
||
You will need to add that library to your other devices if you plan to have that content synced between them. | ||
|
||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,49 @@ | ||
--- | ||
sidebar_position: 2 | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Custom import services | ||
|
||
Panels have support with external services to make it easier to import content into the app. | ||
|
||
Most of those services work the same way and are accessible from the library content screen -> top right "..." button -> connect service option. | ||
|
||
<img src="/img/content-browser-options.jpeg" alt="iPhone showing content browser options" style={{width: 400}} /> | ||
|
||
## Dropbox | ||
|
||
Follow the instructions on the screen to authenticate your Dropbox account. Once set up, you will see a new option appear under Import Services showing a Dropbox icon. Use that to navigate your content and select which files you want to download. | ||
|
||
After choosing which files to import, they will appear in "Downloads" as they are downloaded. Once finished, they will show up in your library. | ||
|
||
## One Drive | ||
|
||
Follow the instructions on the screen to authenticate your One Drive account. Once set up, you will see a new option appear under Import Services showing a One Drive icon. Use that to navigate your content and select which files you want to download. | ||
|
||
After choosing which files to import, they will appear in "Downloads" as they are downloaded. Once finished, they will show up in your library. | ||
|
||
## SMB server | ||
|
||
You can use the Server Message Block (SMB) protocol to share files between devices on the same network. For example, you can enable it on your Mac or NAS, and access the files to download from your iPhone/iPad. | ||
|
||
If you want to enable it from your Mac, you can [follow this simple guide](https://support.apple.com/guide/mac-help/set-up-smb-file-sharing-on-mac-mh14107). | ||
|
||
Once enabled, make sure to grab the smb url (example: "smb://192.168.68.72"). | ||
|
||
Go to Panels, add new service and select SMB Server. Enter the address, username (and optional password) to connect. Once connected, you will have access to the shared folder. Select the files you wish to download to your phone. | ||
|
||
## OPDS (as import service) | ||
|
||
The way you add an OPDS server to Panels is the same as other services, just tap on "..." -> Connect Service -> OPDS. | ||
|
||
We cover OPDS in full detail in [your content in your server](opds.md). | ||
|
||
Once you enter your credentials, OPDS will appear both as a new library and as an Import Service. | ||
|
||
<img src="/img/opds-server-example.jpeg" alt="iPhone showing OPDS server" style={{width: 400}} /> | ||
|
||
If you tap on the one under "Import services", you will be able to navigate your server and select which files to download to your library. After selecting a title or titles and tapping "import", you will be prompted to select the destination. You can navigate your library and place the content anywhere. The download will start, and once finished, it will appear and be ready for you to read in your library. | ||
|
||
## Files app | ||
|
||
Files app is probably the easiest of our importing services. Just tap on "import from files" and you will see a new modal to navigate your devices files. Find the files and tap "Open" to start importing them and selecting a destination. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,15 @@ | ||
--- | ||
sidebar_position: 4 | ||
sidebar_position: 5 | ||
--- | ||
|
||
# Your content in your server | ||
# OPDS: Your own server | ||
|
||
// OPDS | ||
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](icloud-drive.md) or have it stored in your own server. | ||
|
||
Panels can connect to server using the OPDS protocol. There are multiple server implementations that are 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. | ||
|
||
For Komga in particular, we added a full guide on how to set it up with Panels: https://komga.org/docs/guides/panels | ||
|
||
All OPDS servers operate similarly from Panels' side, so we recommend following that guide. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Supported files | ||
|
||
Panels supports the following formats: | ||
|
||
- cbz (zip) | ||
- cbr (rar) | ||
- cb7 (7z) | ||
- comic ePUBs\* | ||
|
||
Container files (like cbz/cbr/cb7) can contain jpg, png and webp files. | ||
|
||
:::info | ||
|
||
**Comic ePUBs**: Panels can open epub files but will warn you when trying to open a text ePUB. We do not support text formatting, our app's main focus is on image-based books, so don't expect support for text books. | ||
|
||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Syncing reading sessions | ||
|
||
Panels keeps track of your progress for each individual file, as well as time spent reading, and many other things like default reading preset for each comic file. | ||
|
||
This is what we call **Reading Sessions**. Reading sessions are synced automatically to your Panels account. Make sure you log in with the same account in all your devices -- that's it. | ||
|
||
To do that, head to the app settings, and tap on the first row. Use either google or apple sign in. | ||
|
||
<img src="/img/sign-in-panels.PNG" alt="iPhone showing panels settings" style={{width: 400}} /> | ||
<img src="/img/panels-account.PNG" alt="iPhone showing log in with your panels account" style={{width: 400}} /> | ||
|
||
We also use that information to drive the Reading now tab. |
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,20 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Multiple libraries | ||
|
||
Talk about the default library "on my XXX". | ||
A Panels library is just a folder (containing other folders and/or files). You can access your default folder using Files app, navigating to "On my iPhone/iPad" -> Panels (the folder has the Panels app icon on it). | ||
|
||
Panels creates a default library when the app is installed. You will see the this library inside Panels referred to as "On my iPhone/iPad". | ||
|
||
## Adding more libraries | ||
|
||
From within Panels app, you can add more libraries. Those libraries can be other folders located in your devices, can be [other folders located in iCloud Drive](../import-content/icloud-drive.md), [located in your own server](../import-content/opds.md) or they can even be located in an **external disk connected via cable**. | ||
|
||
To add a new library, simply go to the library tab, go back to Content, tap on the "..." icon and select add a new library. | ||
Locate the root folder and tap Open. | ||
|
||
<img src="/img/content-browser-options-library.jpeg" alt="iPhone showing content browser options" style={{width: 400}} /> | ||
|
||
:::tip | ||
|
||
If you want to quickly configure or delete a library, simply swipe left from the list of libraries. | ||
|
||
Explain how to add a library from another folder in the system, folder from iCloud Drive (and link to ../import-content/icloud-drive.md) and explain the possibility of having a library in an external disk. | ||
::: |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.