Difference between revisions of "Creating and Maintaining a Module Repository"

From CrossWire Bible Society
Jump to: navigation, search
(→‎Zipped files)
(→‎Registering your repository with CrossWire)
 
(49 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
== Layout of a Module repository ==
+
==A simple repository ==
 +
The most basic way to set up a remote repository is to simply point an anonymous
 +
[http://en.wikipedia.org/wiki/File_Transfer_Protocol 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). 
  
−
A module [http://en.wikipedia.org/wiki/Repository repository] is an echo of the '''mods.d''' and '''modules''' area as found under any Sword module area on your system (e.g. '''~/.sword''') plus '''mods.d.tar.gz''', as created by:
+
All our frontends should be able then to access this repository and download your modules.
  
−
tar czvf mods.d.tar.gz mods.d/*
+
== Complete layout of a larger module repository ==
  
−
Several front ends (particularly for small devices) do require modules in a different format though, as a zipped file.
+
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.
  
−
'''mods.d.tar.gz''' is a [http://en.wikipedia.org/wiki/Gzip gzipped] file.
+
tar czvf mods.d.tar.gz mods.d/*
−
 
 
−
== Zipped files ==
 
  
−
Some of the smaller devices running a sword frontend 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.
+
JSword front-ends require at the moment (though not for much longer) the 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 remote users faster.
  
−
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.
+
== Registering your repository with CrossWire ==
  
−
These come in three formats
+
Most front-ends can install modules from a number of repositories. All recognised repositories are listed in [[Official and Affiliated 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).
  
−
* rawzip (required by JSword derrived front-ends)
+
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. We would not endorse a repository that has content in breach of [[copyright]].
−
* zip for MS Windows
 
−
* zip for Mac OSX
 
  
−
== Jsword/BibleDesktop ==
+
== See also ==
  
−
Jsword derrived frontends use a different module management process.
+
* [[Zipped modules]]
 +
* [[Modules_in_the_beta_repository|Testing status of Beta modules]]
  
−
Firstly they require a HTTP connection, secondly they require only '''mods.d.tar.gz''' and a  directory of zipped modules (rawzip format).
 
  
−
== References ==
+
[[Category:Guides|Creating and Maintaining a Module Repository]]
−
# [http://www.amazon.com/s?ie=UTF8&tag=mozilla-20&index=blended&link_code=qs&field-keywords=Access%20Denied%3A%20The%20Practice%20and%20Policy%20of%20Global%20Internet%20Filtering Access Denied: The Practice and Policy of Global Internet Filtering (Information Revolution and Global Politics)].
+
[[Category:Modules|Creating and Maintaining a Module Repository]]
 +
[[Category:Repositories|Creating and Maintaining a Module Repository]]

Latest revision as of 15:35, 10 January 2018

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) the presence of the modules as zipped archive files. Having these available will also likely be a way in the future to make interaction with remote users faster.

Registering your repository with CrossWire

Most front-ends can install modules from a number of repositories. All recognised repositories are listed in Official and Affiliated 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. We would not endorse a repository that has content in breach of copyright.

See also

Retrieved from "https://wiki.crosswire.org/index.php?title=Creating_and_Maintaining_a_Module_Repository&oldid=16291"