Difference between revisions of "Creating and Maintaining a Module Repository"
(→Layout of a Module repository) |
(→Registering your repository with CrossWire) |
||
| (41 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | The most basic way to | + | ==A simple repository == |
| − | FTP server to any working SWORD module installation (i.e. if | + | The most basic way to set up a remote repository is to simply point an anonymous |
| − | /usr/share/sword works for your | + | [http://en.wikipedia.org/wiki/File_Transfer_Protocol FTP] server to any working SWORD module installation (i.e. if |
| − | via your FTP server and your module repository is done). All | + | '''/usr/share/sword''' works for your front-ends, then expose this directory |
| − | frontends should | + | 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 == | == 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. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | To optimize a repository with | ||
| − | archive file of the mods.d directory | ||
| − | will work fine without this but adding the file will | ||
| − | |||
| − | |||
| − | |||
tar czvf mods.d.tar.gz mods.d/* | 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 modules| 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 == | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | * [[Zipped modules]] | |
| + | * [[Modules_in_the_beta_repository|Testing status of Beta modules]] | ||
| − | |||
| − | + | [[Category:Guides|Creating and Maintaining a Module Repository]] | |
| − | + | [[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
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) 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.
