Title:
SiSU - Remote Operations
Creator:
Ralph Amissah
Rights:
Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
Type:
information
Subject:
ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
Date created:
Date issued:
Date available:
Date modified:
Date:
2007-09-16
1
SiSU - Remote Operations, Ralph Amissah
2
SiSU Remote Operations
3
1. Remote Source Documents
4
SiSU processing instructions can be run against remote source
documents by providing the url of the documents against which the
processing instructions are to be carried out. The remote SiSU
documents can either be sisu marked up files in plaintext .sst or .ssm
or; zipped sisu files, sisupod.zip or filename.ssp
5
.sst / .ssm - sisu text files
6
SiSU can be run against source text files on a remote machine,
provide the processing instruction and the url. The source file and any
associated parts (such as images) will be downloaded and generated
locally.
7
sisu -3 http://[provide url to valid .sst or .ssm file]
8
Any of the source documents in the sisu examples page can be used in
this way, see < http://www.jus.uio.no/sisu/SiSU/2.html>
and use the url for the desired document.
9
NOTE: to set up a remote machine to serve SiSU documents in this
way, images should be in the directory relative to the document source
../_sisu/image
10
sisupod - zipped sisu files
11
A sisupod is the zipped content of a sisu marked up text or texts and
any other associated parts to the document such as images.
12
SiSU can be run against a sisupod on a (local or) remote
machine, provide the processing instruction and the url, the sisupod
will be downloaded and the documents it contains generated locally.
13
sisu -3 http://[provide url to valid sisupod.zip or .ssp file]
14
Any of the source documents in the sisu examples page can be used in
this way, see < http://www.jus.uio.no/sisu/SiSU/2.html>
and use the url for the desired document.
15
Remote Document Output
16
2. Remote Output
17
Once properly configured SiSU output can be automatically posted
once generated to a designated remote machine using either rsync, or
scp.
18
In order to do this some ssh authentication agent and keychain or
similar tool will need to be configured. Once that is done the
placement on a remote host can be done seamlessly with the -r (for scp)
or -R (for rsync) flag, which may be used in conjunction with other
processing flags, e.g.
19
sisu -3R sisu_remote.sst
20
2.1 commands
21
-R [filename/wildcard] copies sisu output files to remote
host using rsync. This requires that sisurc.yml has been provided with
information on hostname and username, and that you have your "keys" and
ssh agent in place. Note the behavior of rsync different if -R is used
with other flags from if used alone. Alone the rsync --delete parameter
is sent, useful for cleaning the remote directory (when -R is used
together with other flags, it is not). Also see -r
22
-r [filename/wildcard] copies sisu output files to remote
host using scp. This requires that sisurc.yml has been provided with
information on hostname and username, and that you have your "keys" and
ssh agent in place. Also see -R
23
2.2 configuration
24
[expand on the setting up of an ssh-agent / keychain]
25
3. Remote Servers
26
As SiSU is generally operated using the command line, and works
within a Unix type environment, SiSU the program and all
documents can just as easily be on a remote server, to which you are
logged on using a terminal, and commands and operations would be pretty
much the same as they would be on your local machine.