simon/smeagol
1
0
Fork 0
mirror of https://github.com/journeyman-cc/smeagol.git synced 2026-04-12 18:05:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Upversioned to '1.0.3-SNAPSHOT'; amended README.

Browse source
This commit is contained in:
Simon Brooke 2020-01-23 08:43:49 +00:00
parent 4d5f1d553d
commit 6e907cc85d
2 changed files with 39 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -110,38 +110,29 @@ Parameters semantics:
Security warning: At the moment there is no check against directory traversal attack. So include feature may expose files outside of your wiki content-dir.
## Advertisement
If you like what you see here, I am available for work on open source Clojure projects.
### Phoning home
Smeagol currently requests the WEFT logo in the page footer from my home site. This is mainly so I can get a feel for how many people are using the product. If you object to this, edit the file
resources/templates/base.html
and replace the line
<img height="16" width="16" alt="The Web Engineering Factory &amp; Toolworks" src="http://www.weft.scot/images/weft.logo.64.png"> Developed by <a href="http://www.weft.scot/">WEFT</a>
with the line
<img height="16" width="16" alt="The Web Engineering Factory &amp; Toolworks" src="img/weft.logo.64.png"> Developed by <a href="http://www.weft.scot/">WEFT</a>
## License
Copyright © 2014-2015 Simon Brooke. Licensed under the GNU General Public License,
version 2.0 or (at your option) any later version. If you wish to incorporate
parts of Smeagol into another open source project which uses a less restrictive
license, please contact me; I'm open to dual licensing it.
## Prerequisites
You will need [Leiningen](https://github.com/technomancy/leiningen) 2.0 or above installed.
You will need [node](https://nodejs.org/en/) and [bower](https://bower.io/) installed.
## Running
To start a web server for the application, run:
## Development
To start a development web server for the application, run:
lein bower install
lein ring server
lein repl
And then, when the repl starts up,
(start-server)
## Running
To build a standalone Smeagol jar file, run:
lein bower install
lein ring uberjar
**HOWEVER**, this will not run without [configuration](https://github.com/journeyman-cc/smeagol/blob/develop/resources/public/content/Environment%20Variables.md).
Alternatively, if you want to deploy to a servlet container (which I would strongly recommend), the simplest thing is to run:
@ -172,3 +163,25 @@ To build your own Docker image, run:
lein docker build
This will build a new Docker image locally; you can, obviously, push it to your own Docker repository if you wish.
## Advertisement
If you like what you see here, I am available for work on open source Clojure projects.
### Phoning home
Smeagol currently requests the WEFT logo in the page footer from my home site. This is mainly so I can get a feel for how many people are using the product. If you object to this, edit the file
resources/templates/base.html
and replace the line
<img height="16" width="16" alt="The Web Engineering Factory &amp; Toolworks" src="http://www.weft.scot/images/weft.logo.64.png"> Developed by <a href="http://www.weft.scot/">WEFT</a>
with the line
<img height="16" width="16" alt="The Web Engineering Factory &amp; Toolworks" src="img/weft.logo.64.png"> Developed by <a href="http://www.weft.scot/">WEFT</a>
## License
Copyright © 2014-2020 Simon Brooke. Licensed under the GNU General Public License,
version 2.0 or (at your option) any later version. If you wish to incorporate
parts of Smeagol into another open source project which uses a less restrictive
license, please contact me; I'm open to dual licensing it.