WiseMapping

https://github.com/wisemapping/wisemapping-open-source
Admin
WiseMapping is an open-source, web-based mind mapping tool built with SVG and React, offering a...
Tokens:1,840
Snippets:16
Trust Score:5.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Compile and Start WiseMapping Frontend

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/README.md

These commands set environment variables, navigate to the frontend directory, install dependencies, build the project, and then start the frontend web application. This requires checking out the `wisemapping-frontend` repository separately.

```Shell
$ export NODE_OPTIONS=--openssl-legacy-provider
$ export APP_CONFIG_TYPE="file:dev"

$ cd wisemapping-frontend
$ yarn install 
$ yarn build

$ cd packages/webapp; yarn start
```

--------------------------------

### Execute MySQL Database Setup Scripts via Command Line

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/config/README.md

This snippet demonstrates how to navigate to the MySQL configuration directory and execute the WiseMapping database setup scripts using the MySQL command-line client. It covers creating the database, schemas, and populating them with example data and a test user. It also notes considerations for the MySQL root user password and the 'wisemapping' user credentials.

```bash
cd <WISEMAPPING-DIR>/config/database/mysql
# Default MySQL installation creates a "root" user with empty password. You can connect to the database with this user if you are # logged in same machine where the database is installed and must be executed logged as "root" 
#
# If you have changed the default database "root" password , you need to specify an additional -p parameter and provide the
# new password.
mysql -uroot < create-database.sql

# Create tables and default tests user
mysql -uwisemapping -Dwisemapping -ppassword < create-schemas.sql 
mysql -uwisemapping -Dwisemapping -ppassword < apopulate-schemas.sql
```

--------------------------------

### Quick Start WiseMapping with Docker Compose

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/README.md

This command sequence compiles the backend API and then starts the WiseMapping application locally using Docker Compose, leveraging an in-memory HSQLDB for development. The application will be accessible at http://localhost/c/login.

```Shell
$ mvn -f wise-api/pom.xml package
$ docker compose up --build
```

--------------------------------

### Run WiseMapping Docker with HSQL In-Memory

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/distribution/README.md

This command starts the WiseMapping Docker container using an in-memory HSQL database. This setup is ideal for quick testing as all data is lost when the container stops.

```bash
docker run -it --rm -p 8080:8080 wisemapping/wisemapping:latest
```

--------------------------------

### Run WiseMapping API with External Configuration

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/README.md

This command demonstrates how to start the WiseMapping backend API JAR file, specifying an additional configuration location. This allows overriding default settings defined in `application.yaml` with a custom `app.yml` file.

```Shell
$ java -jar target/wisemapping-api.jar --spring.config.additional-location=../../wise-conf/app.yml
```

--------------------------------

### Compile and Start WiseMapping Backend API

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/README.md

These commands compile the WiseMapping backend API using Maven and then start the Spring Boot application. This is part of the 'Option 2' for starting the application without Docker Compose.

```Shell
$ mvn -f wise-api/pom.xml package
$ cd wise-api
$ mvn spring-boot:run
```

--------------------------------

### Set Up Persistent HSQL Database for WiseMapping Docker

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/distribution/README.md

These commands facilitate setting up a persistent HSQL database for WiseMapping. It involves creating a local directory, running a temporary container to copy the default database, and then stopping it. This is a one-time setup.

```bash
mkdir your-db-dir-store-path

docker run --name wiseapp -d --mount type=bind,source=your-db-dir-store-path,target=/var/lib/wise-db wisemapping/wisemapping:latest

docker cp wiseapp:/var/lib/wisemapping/db your-db-dir-store-path

docker stop wiseapp;docker rm wiseapp
```

--------------------------------

### Run WiseMapping Docker with External app.properties

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/distribution/README.md

This command starts the WiseMapping Docker container, mounting a custom `app.properties` file. This allows WiseMapping to connect to an external MySQL or PostgreSQL database as configured in the properties file.

```bash
docker run --mount type=bind,source=your-file-path/app.properties,target=/usr/local/tomcat/webapps/ROOT/WEB-INF/app.properties -it --rm -p 8080:8080 wisemapping/wisemapping:latest
```

--------------------------------

### Retrieve User Information by Email (CURL)

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/wise-api/doc/REST Services.md

Demonstrates how to fetch user details using their email address via a GET request. This example requires basic authentication and uses placeholder variables for host, port, and context path.

```Shell
curl "http://{host.name}:{host.port}/{context.path}/service/admin/users/email/{user.email}.json" --GET --basic -u "admin@wisemapping.org:test"
```

--------------------------------

### Create New User (CURL)

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/wise-api/doc/REST Services.md

Provides an example of creating a new user account using a POST request. User details are sent as a JSON payload with 'Content-Type:application/json'. This operation requires basic authentication and uses placeholder variables for server details.

```Shell
curl "http://{host.name}:{host.port}/{context.path}/service/admin/users/" --request POST --basic -u "admin@wisemapping.org:test" -H "Content-Type:application/json" --data '{"email": "te2@mydomain.de", "lastname": "lastname", "firstname":"myfirstname","password":"password"}'
```

--------------------------------

### Download WiseMapping app.properties for External DB

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/distribution/README.md

This command downloads the default `app.properties` configuration file. This file needs to be modified to configure WiseMapping for external MySQL or PostgreSQL databases.

```bash
curl https://bitbucket.org/wisemapping/wisemapping-open-source/src/master/wise-webapp/src/main/webapp/WEB-INF/app.properties
```

--------------------------------

### Run WiseMapping Docker with Mounted Persistent HSQL

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/distribution/README.md

After setting up the persistent HSQL database, this command runs the WiseMapping Docker container, mounting the previously copied database directory. This ensures data persistence across container restarts.

```bash
docker run --mount type=bind,source=your-db-dir-store-path/db,target=/var/lib/wisemapping/db -it --rm -p 8080:8080 wisemapping/wisemapping:latest
```

--------------------------------

### WiseMapping REST API Endpoints Overview

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/wise-api/doc/REST Services.md

Defines the structure and methods for key WiseMapping REST API endpoints related to user administration, including template paths, HTTP methods, and expected parameters or body content.

```APIDOC
Endpoint: /service/admin/users/email/{user.email}.json
  Method: GET
  Parameters:
    user.email: string (User's email address)

Endpoint: /service/admin/users/{userId}
  Method: DELETE
  Parameters:
    userId: string (ID of the user to delete)

Endpoint: /service/admin/users/{userId}/password
  Method: PUT
  Parameters:
    userId: string (ID of the user whose password will be changed)
    new_password: string (New password, sent in request body as plain text)

Endpoint: /service/admin/users/
  Method: POST
  Body:
    email: string (User's email address)
    lastname: string (User's last name)
    firstname: string (User's first name)
    password: string (User's password)
```

--------------------------------

### Increase Tomcat Memory in WiseMapping Docker Container

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/distribution/README.md

This command runs the WiseMapping Docker container with increased Tomcat memory allocation. It uses `JAVA_OPTS` to set initial and maximum RAM percentages, and directly allocates 1.5GB of memory to the container, improving performance for demanding workloads.

```bash
docker run\
--mount type=bind,source<your-file-path/app.properties,target=/usr/local/tomcat/webapps/ROOT/classes/app.properties\
-m 1.5GB -e JAVA_OPTS=" -XX:+PrintFlagsFinal -XX:InitialRAMPercentage=30 -XX:MaxRAMPercentage=80"\
-it --rm -p 8888:8080 veigap/wisemapping:latest
```

--------------------------------

### Delete User by ID (CURL)

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/wise-api/doc/REST Services.md

Shows how to delete a user account based on their user ID using a DELETE request. This operation requires basic authentication and uses placeholder variables for the server details.

```Shell
curl "http://{host.name}:{host.port}/{context.path}/service/admin/users/{userId}" --request DELETE --basic -u "admin@wisemapping.org:test"
```

--------------------------------

### Change User Password by ID (CURL)

Source: https://github.com/wisemapping/wisemapping-open-source/blob/develop/wise-api/doc/REST Services.md

Illustrates how to update a user's password using a PUT request. The new password is sent in the request body with 'Content-Type:text/plain'. Basic authentication is required, and server details are represented by placeholders.

```Shell
curl "http://{host.name}:{host.port}/{context.path}/service/admin/users/{userId}/password" --request PUT --basic -u "admin@wisemapping.org:test" -H "Content-Type:text/plain" --data "<new_password>"
```
Tokens:
Raw