Skip to content
eXist code for Syriaca.org: The Syriac Reference Portal
Branch: master
Clone or download
Pull request Compare This branch is 2476 commits ahead of wsalesky:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
CTS
api-documentation
authors
bhse
bibl
build
d3xquery
documentation
geo
lives
modules
nhsl
persons
q
resources
saints
sparql
taxonomy
templates
.gitignore
301.html
404.html
500.html
LICENSE
README.md
about-menu.html
about-srophe.html
about-syriac.html
about.html
banner.html
browse.html
build.xml
collection.xconf
contact-us.html
controller.xql
error-page.html
expath-pkg.xml
facet-def.xml
index.html
media-releases.html
pre-install.xql
project-partners.html
project-team.html
record.html
repo-config.xml
repo.xml
search-config.xml
search-facets.html
search.html
searchTips.html

README.md

Syriaca.org

Application data for Syriaca.org [http://syriaca.org]: The Syriac Reference Portal All publications of Syriaca.org are made available online in a free and open format using the Creative Commons licenses.

This is a customization of The Srophé Application [https://github.com/srophe/srophe]. Version 3.0 of this software represents a major code refactor and is not backwards compatible with earlier versions of the code. To access an earlier version use tag v2.x. To use the software with your own data fork or clone a version of the The Srophé Application [https://github.com/srophe/srophe].

Dependencies

TEI data

Syriaca.org TEI data for publications is available: [https://github.com/srophe/srophe-app-data] The data must be packaged and deployed to your eXist instance in order to use the syriaca.org app.

Additional dependancies

Check that the following packages/libraries are deployed in eXist before deploying the srophe-eXist-app:

Packages can be deployed via the eXistdb dashboard.

Setting up Github webhooks

Syrica.org uses Github webhooks [https://developer.github.com/webhooks/] to keep the remote application upto date with the github repository.

  • Requires the EXPath Crypto library to verify Github submissions. [http://exist-db.org:8098/exist/apps/public-repo/packages/expath-crypto-exist-lib.html]

  • Requires a config file added to the app home directory. Do not store this file in your github repository. Example:

    <config>
        <!-- Configuration for Github webhooks sync feature -->
        <git-config>
            <!-- github secret key can be stored here or as a environment variable. (prefered)  -->
            <private-key/>
            <private-key-variable>VARIABLE_NAME</private-key-variable>
            <!-- github token for rate limiting. can be stored here or as a environment variable. (prefered)  -->
            <gitToken/>
            <gitToken-variable/>
            <!-- Branch to sync, if empty assumes master -->
            <github-branch>master</github-branch>
            <!-- Collection in eXistdb to sync app to. example: /db/apps/srophe -->
            <exist-collection>/db/apps/srophe</exist-collection>
            <!-- App root in git repository. example: srophe-app -->
            <repo-name>srophe-app</repo-name>
        </git-config>
    </config>
    
  • Setup webhooks on your github repository, Syriaca.org XQuery endpoint: http://localhost:8080/exist/apps/srophe/modules/git-sync.xql. [https://developer.github.com/webhooks/creating/]

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.