Skip to content

Commit

Permalink
Merge pull request #174 from ezpaarse-project/docs/install
Browse files Browse the repository at this point in the history
docs: update install docs
  • Loading branch information
nojhamster authored Jun 20, 2024
2 parents 487df29 + 3121c19 commit d9a8f6c
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 13 deletions.
Binary file added doc/src/guide/images/install-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/src/guide/images/install-warning-mongo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 52 additions & 13 deletions doc/src/start/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,36 @@ Make sure you fulfilled the [requirements](./requirements.html) before going any

For an ezPAARSE installation on a **Windows** OS, you will have to use a dockerized container. Please see [below](install.html#docker-and-compose).

## Without Docker
## ezPAARSE

### With source code

1. Clone the repository

### Stable version
To install the last stable version on a Unix system, open a console and enter:
```bash
git clone https://github.com/ezpaarse-project/ezpaarse.git
cd ezpaarse
git checkout `git describe --tags --abbrev=0`
make
git clone https://github.com/ezpaarse-project/ezpaarse
```
#### Video Demonstration
This [screencast](https://www.youtube.com/watch?v=W77vPsgC1A8) demonstrates the previous instructions.

### Development version
If you wish to install the development version, open a console and enter:
2. Go to ezPAARSE directory and use the command **make** to install.

This command will will check whether your server has all the necessary prerequisites and download all dependencies and resources to enable ezPAARSE to work properly.

```bash
git clone https://github.com/ezpaarse-project/ezpaarse.git
cd ezpaarse
git checkout `git describe --tags --abbrev=0`
make
```

## With Docker and Compose
> [!NOTE]
> There may be an error saying that it is impossible to connect to mongodb. If there is only this error, it still means that ezPAARSE has been installed correctly, but that no mongoDB is installed.
![image](../guide/images/install-warning-mongo.png)

At the end of the command, you should see this type of result.

![image](../guide/images/install-result.png)

### With docker

ezPAARSE is available as a [docker image](https://registry.hub.docker.com/r/ezpaarseproject/ezpaarse).

Expand All @@ -44,3 +52,34 @@ git clone https://github.com/ezpaarse-project/ezpaarse.git
cd ezpaarse
test -f config.local.json || echo '{}' > config.local.json
```

> [!NOTE]
> If you install ezPAARSE with docker compose, there's no need to install mongodb in addition.
## MongoDB

ezPAARSE needs a mongodb to work, it can store the admin account, PKBs cache and processing history.
by default,
ezPAARSE tries to connect to a mongodb which is available on port 27017.

> [!NOTE]
> ezPAARSE loads PKBs on mongodb. As of mongodb version 6, this feature is no longer available.
### Official packages

You can install mongodb on your server via [official packages](https://www.mongodb.com/docs/manual/installation/).

### Docker

It's easier to install mongodb at the right version with docker.

```bash
# Create mongodb image.
# You can use other versions but this may have an impact on PKB.
docker run -p 27017:27017 --name ezpaarse-db -d mongo:3.6.23
# Start mongodb.
docker start ezpaarse-db
# Stop mongodb.
docker stop ezpaarse-db
```

0 comments on commit d9a8f6c

Please sign in to comment.