Configuration
The various configuration options for servers in the mobile app
This page will be split into two primary sections: overall server-specific features and configuration options, and then a more step-by-step guide for adding, editing, and deleting servers.
Networking
There are two notable networking-related features in the app:
- The ability to configure custom headers for each server
- The ability to configure a local-network fallback URL for querying each server
Custom Headers
This does not apply to all servers, but some servers may require custom headers to be sent with each request from the app. For example, Komga supports a X-API-Key header for its long-lived token-based authentication. In this case, you would configure the X-API-Key header with your Komga API key as the value so each request made to the Komga server from the app would be authenticated.
Local Network URL
It is fairly common for servers to be behind some kind of reverse proxy or VPN for improved access when away from your home network. However, if you are on your home network you might not want to proxy all requests and instead just directly connect to your server.
The app supports this by allowing you to configure a local network URL for each server. When the app detects that you are on your home network, it will use the local network URL instead of the primary URL for all requests.
Network Permissions and Privacy
Stump does not collect any information about your location. The app will prompt your for permission to access information related to your network (name, connection status, etc) so it can determine if you are on your configured home network to manage the decision of which URL to use. That said, the permission you grant may have scary language, such as Allow "Stump" to access your location.
If you are using an Apple device, the exact entitlement is com.apple.developer.networking.wifi-info. If you have granted permission and still do not see your wifi network in the app, ensure you have "Precise Location" enabled for the app, as that is seemingly required as well. I do not know why Apple has chosen to operate this way.
If you are using an Android device, you'll need to enable location services for the app to read your network information. Similarly, Android requires the ACCESS_FINE_LOCATION permission to read the wifi network information.
Allow Once vs Allow Always / While Using the App
If you want the feature to work, you must at least allow the app to access your network information while using the app. If you choose to allow once, the app will not read your network information the next time you open the app, and therefore will be unable to determine if you are on the home network to do the URL switch.
This prompt for permission will only appear when you go to configure a local network URL, and will not prompt you for permission until you decide to do so. In other words, if you do not want to use this feature, you will never be prompted for permission and the app will never attempt to read your network information.
Step-by-Step Guides
Adding a Server
The process for adding a Stump server and an OPDS server is the same. The only difference is that an OPDS server requires a URL pointing to the root catalog for the feed
If you configure a Stump server as a dual-mode server, you may use the root URL for the Stump server instead of the catalog URL
Go to the Servers screen
This is the very first screen you will see when you open the app
Click the + button
The button is located in the top right corner of the screen
Select either Stump or OPDS
The very first field labeled Kind will allow you to select the type of server you are configuring. You may choose either Stump or OPDS. If choosing OPDS, you will need to specify the OPDS version, as well.
You can always enter OPDS v1.2 or v2.0 parts of the app with Stump servers, since it supports either in addition to its own native APIs
If OPDS, select the OPDS version
Stump supports both OPDS v1.2 and OPDS v2.0, but it will not auto-detect the version of your OPDS feed. Once you select OPDS as the kind of server you are configuring, There will be an additional field that appears below where you can make your selection. Be sure to select the correct version your server supports.
Fill in the required connection details
The form will have the following required fields related to the actual connection:
- Name: A friendly name for the server
- URL: The URL of the server. If
OPDS, this will be labeledCatalog URL - Auth: The type of authentication to use
If you choose Login for auth, there will be no additional fields to fill in. If you choose Basic, you will need to provide a username and password. If you choose Token, you will need to provide a token
Fill in the optional fields
You may configure the following optional fields:
- Set as default server: If enabled, the app will take you into this server when you open the app instead of the root screen
Editing a Server
Force press on a server in the list to bring up a context menu. Select Edit to edit the server.
The process for editing a server is the same as adding a server, so follow the same steps as above. The notable difference is that you may not name it the same as an existing server
Deleting a Server
Force press on a server in the list to bring up a context menu. Select Remove to delete the server.
You will be presented with a confirmation dialog before the server is deleted. If the server is a dual-mode server, an additional warning will be presented.
Any disk space used by the server will be freed up when the server is deleted. This includes any books downloaded from the server or cached data