Skip to content
This repository has been archived by the owner on Mar 15, 2022. It is now read-only.

Commit

Permalink
docs: Fix issues in Readme and Install.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vikin91 committed May 4, 2019
1 parent e201f6e commit 671471f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 26 deletions.
39 changes: 18 additions & 21 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -52,6 +52,7 @@ The MySQL data is stored in `db_data`, whereas preferences and stats in `json_da
git clone --branch <version> https://github.com/vikin91/BibSpace.git
```
Whereas `<version>` 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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 671471f

Please sign in to comment.