Creating and Maintaining a Module Repository

From CrossWire Bible Society

(Difference between revisions)
Jump to: navigation, search
(Zipped Modules)
(Complete layout of a larger module repository)
Line 13: Line 13:
An echo of the '''mods.d''' and '''modules''' area as found under any Sword module area on your system (e.g. '''~/.sword''') a directory with zipped modules for JSword derived front-ends. This can also serve as a repository for smaller devices without integrated module manager.
An echo of the '''mods.d''' and '''modules''' area as found under any Sword module area on your system (e.g. '''~/.sword''') a directory with zipped modules for JSword derived front-ends. This can also serve as a repository for smaller devices without integrated module manager.
-
This needs to be accessible both via FTP and via HTTP (for direct download and for JSword)
+
This needs to be accessible either via FTP or via HTTP. FTP is more reliable for a variety of reasons.
To optimize a repository with quite a few modules, the '''mods.d.tar.g'''  
To optimize a repository with quite a few modules, the '''mods.d.tar.g'''  

Revision as of 15:11, 5 November 2010

Contents

A simple repository

The most basic way to set up a remote repository is to simply point an anonymous FTP server to any working SWORD module installation (i.e. if /usr/share/sword works for your front-ends, then expose this directory via your FTP server and your module repository is done).

All our frontends should be able then to access this repository and download your modules.

Complete layout of a larger module repository

In order to deal with all ways the various front-ends use our module repository the following should be provided:

An echo of the mods.d and modules area as found under any Sword module area on your system (e.g. ~/.sword) a directory with zipped modules for JSword derived front-ends. This can also serve as a repository for smaller devices without integrated module manager.

This needs to be accessible either via FTP or via HTTP. FTP is more reliable for a variety of reasons.

To optimize a repository with quite a few modules, the mods.d.tar.g archive file of the mods.d directory can be created. The repository will work fine without this but adding the file will optimize repository refresh times for the user if more than a couple modules exist in the repository.

tar czvf mods.d.tar.gz mods.d/*

Zipped Modules

Some of the smaller devices running a sword front-end do not have a network enabled module manager. Users of these devices need to download their modules as zipped files and unzip them in the right place - e.g. a SD card.

It is also helpful for people who have no access to direct internet connections or live in countries with monitored access to the internet[1] to be able to download (and possibly distribute) zipped modules. This is a zipped archive of a module in the file and directory layout used in the local module directory.

E.g. to create from your own module directory a zipped module of a uncompressed GenBook do this:

cd ~ftp/pub/sword
zip zip/mybook.zip mods.d/mybook.conf modules/genbook/rawgenbooks/mybook

Registering your repository with CrossWire

Most front-ends can install modules from a number of repositories. All recognised repositories are listed in Module Repositories. These repositories are well established with CrossWire and are maintained by various developers. If you or your organisation have set up your own repository, please announce it on the mailing list (sword-devel@crosswire.org).

From libsword-1.5.12 onwards the module manager will also be able to load dynamically a list of active and accepted repositories. To enable your repository for this list please contact CrossWire. We will then decide whether we will list your repository as endorsed by us.

References

  1. Access Denied: The Practice and Policy of Global Internet Filtering (Information Revolution and Global Politics).
Personal tools
Namespaces
Variants
Actions
Navigation
Miscellaneous
Toolbox