Custom repositories

Custom repositories specified in this document will be supported in version 5.0+.

Repository manifest file

Sword repository should contain manifest json file of the following format:

{
  "name": "AndBible test",
  "description": "Test module repository maintained by AndBible development team",
  "manifestUrl": "https://andbible.github.io/data/andbible/test/manifest.json",
  "type": "sword-https",
  "host": "andbible.github.io",
  "catalogDirectory": "/data/andbible/test",
  "packageDirectory": "/data/andbible/test/zip"
}

In this example, repository structure will be found in https://andbible.github.io/data/andbible/test (AndBible will look for mods.d.tar.gz file for module conf files index) and module zip files in https://andbible.github.io/data/andbible/test/zip. Only HTTPS repositories are supported (i.e. type can be only sword-https).

Usage

User can paste either https://andbible.github.io/data/andbible/test/manifest.json or https://andbible.github.io/data/andbible/test into "Repository URL" field.

Non-manifest repositories

If repository does not contain manifest file, user can paste repository root folder to "Repository URL" as well. Repository must contain "packages" directory (containing zip files) directly under repository root folder.

MyBible repositories

MyBible repositories as documented here are supported also. Only limitation is that only HTTPS connections are supported (AndBible does not event try to download unencrypted HTTP at all). If http URLs are present, https is tried instead.

Some custom repositories

• Crosswire Attic