# Jecretz Setup

  • Installing Components
    • Wekan v7.61
    • Node.js 14.21.4
    • MongoDB 6.0.18
  • Configure the server
  • Running the server
  • Adding data
    • Users
    • Tickets

# Installing Components

# Wekan v7.61

  • Link to the installation doc for Wekan (version 7.61 was used for testing).
    • Wekan's Windows On-Premise guide contains instructions to download and install Wekan and its dependencies. The node version in this documentation may need adjustments.
  • Download the Wekan installation zip.

# Node.js 14.21.4

Wekan offline setup doc contains this link to node.exe.

  • v14.21.3 was used for testing purposes.
  • If another version is needed, use this release as a fallback.

# MongoDB 6.0.18

Install MongoDB directly from their website.

# Configure the server

Download Wekan's start-wekan.bat script. Wekan suggests extracting the Wekan install zip, and then placing start-wekan.bat and node.exe within the bundle directory alongside main.js:

bundle (directory)
  |_ start-wekan.bat (downloaded file)
  |_ node.exe (downloaded file)
  |_ main.js (extracted file)

Afterwards, modify start-wekan.bat and update the ROOT_URL variable, as well as the PORT and MONGO_URL variables if needed.

# Running the server

Run start-wekan.bat to start the server.

# Adding data

Wekan provides a python script for interacting with its REST API.

Prior to using the script, update the username, password and wekanurl variables in lines 79-83.

# Users

After the admin user is set up and the API script is configured, add new users using the api.py script:

python3 api.py newuser USERNAME EMAIL PASSWORD

# Tickets

After the admin user is set up and the API script is configured, create boards and swimlanes.

To create lists using the API script:

python3 api.py createlist BOARDID LISTTITLE

To create cards using the API script:

python3 api.py addcard AUTHORID BOARDID SWIMLANEID LISTID CARDTITLE CARDDESCRIPTION