Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates with proper install instructions and other misc. #105

Merged
merged 1 commit into from
Jun 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,34 @@ We welcome everyone to work on this cool project. We use a typical PR system:
* Right click on the chosen directory and select 'Set Deploy Workspace Location'.
* You only have to do this once.
6. Actions are available to compile source from your local machine
* Control / Command + E
* Control / Command + E


## Build from source (for development/contribution)

1. `cd Manzan`
* ensure that the working directory is the root of Manzan
2. `gmake install` - installs the Handler (ILE component) into the `MANZAN` library
* change installation library with `BUILDLIB=MANZAN2 gmake install`

After you install Manzan with the makefiles:

* Both the Handler and Distributor are built
* The configuration files (`.ini` extension) get created in `/QOpenSys/etc/manzan/`
* Manzan can be started with `/opt/manzan/bin/manzan`

### Build Distributor (camel) only

To build only the camel component, you can use `camel` as the target:

```sh
gmake camel
```

### Build Handler (ILE) only

To build only the ILE component, you can use `ile` as the target:

```sh
gmake ile
```
4 changes: 4 additions & 0 deletions docs/config/app.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@

**Note: For almost all real-life deploutments of Manzan, this file can remain untouched!**

`app.ini` is made to hold two pieces of information:

* `install` to hold which library the ILE component is installed in
* `remote` to determine what system to connect to. This is primarily intended for development purposes, when the Distributor is running in a different environment than the Handler (e.g. your local Windows system). This information is not used when running on IBM i.


```ini
[install]
library=MANZAN
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
42 changes: 12 additions & 30 deletions docs/install/ibmi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,24 @@ This document will outline how to install Manzan on to IBM i. Manzan is install

Building Manzan is easy for IBM i and we provide makefiles to simplify the entire process.

## Requirements
## Install from GitHub release

To build Manzan, GNU Make (`gmake`), Java and Maven must be setup and on the path so the shell can access them.
To install from a github release, simply perform the following steps:
1. Download the latest binary release from [the releases page](https://github.com/ThePrez/Manzan/releases)
1. If you didn't download to IBM i directly, transfer the `.jar` file to IBM i using technique of your choice
1. Run `java -jar <name of jar file>`

## Install from GitHub release

(coming at a later date)

## Build from source (for Development)

1. `cd Manzan`
* ensure that the working directory is the root of Manzan
2. `gmake install` - installs the Handler (ILE component) into the `MANZAN` library
* change installation library with `BUILDLIB=MANZAN2 gmake install`
For instance, to install version `0.0.6`, the steps from an IBM i (using open source `wget`) would look like:
```bash
wget https://github.com/ThePrez/Manzan/releases/download/v0.0.6/manzan-installer-v0.0.6.jar
java -jar manzan-installer-v0.0.6.jar
```

After you install Manzan with the makefiles:
## Deployment basics

* Both the Handler and Distributor are built
* The configuration files (`.ini` extension) get created in `/QOpenSys/etc/manzan/`
* Manzan can be started with `/opt/manzan/bin/manzan`

### Build Distributor (camel) only

To build only the camel component, you can use `camel` as the target:

```sh
gmake camel
```

### Build Handler (ILE) only

To build only the ILE component, you can use `ile` as the target:

```sh
gmake ile
```
* (optional) It is recommended to use [Service Commander](https://theprez.github.io/ServiceCommander-IBMi/#service-commander-for-ibm-i) to start/stop Manzan (or to have Manzan autostart at IBM)

## Next steps

Expand Down