Creating and Maintaining a Module Repository

From CrossWire Bible Society

(Difference between revisions)
Jump to: navigation, search
m (Complete layout of a larger module repository: JSword)
m (Complete layout of a larger module repository: front-ends)
Line 13: Line 13:
  tar czvf mods.d.tar.gz mods.d/*
  tar czvf mods.d.tar.gz mods.d/*
-
JSword frontends require at the moment (though not for much longer) presence of the modules as [[Zipped modules| zipped archive files]]. Having these available will also likely be a way in the future to make interaction with users faster.
+
JSword front-ends require at the moment (though not for much longer) presence of the modules as [[Zipped modules| zipped archive files]]. Having these available will also likely be a way in the future to make interaction with users faster.
== Registering your repository with CrossWire ==
== Registering your repository with CrossWire ==

Revision as of 17:40, 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

To optimize a repository with a larger number of modules, an archive file of the mods.d directory should be created. The repository will work fine without this but adding the file will speed up use of the repository for remote users.

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

JSword front-ends require at the moment (though not for much longer) presence of the modules as zipped archive files. Having these available will also likely be a way in the future to make interaction with users faster.

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).

The module manager is 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.

see also

Zipped modules

Personal tools
Namespaces
Variants
Actions
Navigation
Miscellaneous
Toolbox