diff --git a/INSTALL.md b/INSTALL.md index 2245de7..3f551ba 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,8 +1,10 @@ -## BibSpace Installation ## +# BibSpace Installation +## Native Installation + +Tested for Debian-based operating systems. -### Quick installation for Debian-based operating systems ### ```bash cd ~ sudo aptitude update @@ -23,48 +25,43 @@ prove -lr # if all tests pass then the system is ready for use ``` +## Running Natively-installed BibSpace -### Running BibSpace ### +If all tests are passed then you may finally start BibSpace. -If all tests are passed then you may finally **start BibSpace** +Due to incompatibility with perfork, I recomend using the *build-in server* for BibSpace `v0.5.x`: ```bash -# provide config export BIBSPACE_CONFIG=lib/BibSpace/files/config/default.conf -# using hypnotoad (currently not recomended for version 0.5.0 due to prefork) -hypnotoad ./bin/bibspace -# using built-in server bin/bibspace daemon -m production -l http://*:8080 ``` +However, for other versions, in particular `0.6.x`, the `hypnotoad` may be used: + +```bash +export BIBSPACE_CONFIG=lib/BibSpace/files/config/default.conf +hypnotoad ./bin/bibspace +``` + To **stop BibSpace** ```bash hypnotoad -s ./bin/bibspace ``` +Bibspace may also be run in **developer mode** to see all errors and debug messages. -you may also run it in **developer mode** to see errors, debug messages etc. ```bash morbo -l http://*:8080 ./bin/bibspace -# or +# or alternatively bin/bibspace daemon -m development -l http://*:8080 ``` - Finally, you mah head to your browser, **login, and use the system** + ``` http://YOUR_SERVER_IP:8080 Admin login: pub_admin Admin password: asdf ``` -Remeber to cofigure your firewall if you cannot connect to the port 8080. - -### Running BibSpace in Production ### - -#### TODO #### -- [] Configure reverse proxy nginx -- [] Configure reverse proxy apache2 - - - +Configure your firewall allow traffic on port 8080 if you cannot connect to the port 8080. diff --git a/README.md b/README.md index d7d0141..c291a33 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -# README # +# README BibSpace is an Online Bibtex Publications Management Software for Authors and Research Groups. Read about its features at the _Error Blog_ under: [BibSpace @ the Error Blog](https://blog.hex64.com/bibspace-online-bibtex-publications-management-software-for-authors-and-research-groups/). -## Build status ## +## Build Status [![Build Status](https://travis-ci.org/vikin91/BibSpace.svg?branch=master)](https://travis-ci.org/vikin91/BibSpace) [![Coverage Status](https://coveralls.io/repos/github/vikin91/BibSpace/badge.svg?branch=master)](https://coveralls.io/github/vikin91/BibSpace?branch=master) -## Installation ## +## Native Installation * See [INSTALL.md](INSTALL.md) -## Using BibSpace with Docker ## +## Using BibSpace with Docker ### Testing @@ -52,6 +52,7 @@ The MySQL data is stored in `db_data`, whereas preferences and stats in `json_da git clone --branch https://github.com/vikin91/BibSpace.git ``` Whereas `` equals the name of a branch or release tag, for example: `v0.5.4`. + 3. (Optional) Restore backup if any data got lost. #### Any update of Docker installation @@ -98,7 +99,7 @@ mkdir -p json_data mv *.json json_data/ ``` -## TODOs ## +## TODOs I currently work on BibSpace to improve several things. I ship code in coding sessions that happen rather rarely - once, twice per year.