Rooba
/
perkeep
mirror of https://github.com/perkeep/perkeep.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: explain how publisher paths work with permanodes 

Change-Id: I7ddf1c5f2bc93961fbadba978e65819c0bdf5b24
This commit is contained in:
Attila Tajti 2017-01-18 07:52:08 +01:00
parent abc6561c60
commit c275aed960
2 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/publishing/README.md
View File

@ -25,6 +25,24 @@ configure publishing for an image gallery in the server config
}
}
For this to work you need a single permanode with an attribute "camliRoot"
set to "mypics" which will serve as the root node for publishing.
Suppose you want to publish two permanodes as "foo" and "bar". The root node
needs the following atributes:
camliRoot = mypics // must match server-config.json
camilPath:foo = sha1-foo
camliPath:bar = sha1-bar
where sha1-foo (and sha1-bar) is either a permanode with some camliContent,
or a permanode with some camliMembers.
This will serve content at the publisher root http(s)://«camlihost:port»/pics/
but note that publisher hides the contents of the root path.
Keeping with the example above, it would serve
http(s)://«camlihost:port»/pics/foo and http(s)://«camlihost:port»/pics/bar .
The parameters for setting up the app's process ("listen", "backendURL", and
"apiHost") are derived from the Camlistore server's "listen", and "baseURL", but
should the need arise (e.g. with a proxy setup) they can be specified as well.

3
doc/server-config.md
View File

@ -142,7 +142,8 @@ One can create any permanode with camput or the UI, and set its camliRoot
attribute to the value set in the config, to use it as the root permanode for
publishing.
Please see the [publishing README](/doc/publishing/README) if you want to
Please see the [publishing README](/doc/publishing/README) for further details
on how to set up permanodes for publishing, or if you want to
make/contribute more publishing views.