8 Commits

Author SHA1 Message Date
Paulo Gustavo Veiga
2c9a181496 Update springboot version. 2024-05-21 20:02:35 -07:00
Paulo Gustavo Veiga
82d5caa1ea Merge branch 'develop' of github.com:wisemapping/wisemapping-open-source into develop 2024-04-06 08:45:28 -07:00
Paulo Gustavo Veiga
c71da91af0 Improve application.yml documentation. 2024-04-06 08:43:20 -07:00
Paulo Gustavo Veiga
a89a4ff049 Update README.md 2024-04-06 02:58:12 -07:00
Paulo Gustavo Veiga
20f730eb36 Update README.md 2024-04-06 02:56:54 -07:00
Paulo Gustavo Veiga
ec7dd972b6 Update README.md 2024-04-06 02:53:39 -07:00
Paulo Gustavo Veiga
0d3d28b871 Minor change 2024-04-06 02:52:44 -07:00
Paulo Gustavo Veiga
b04baef6e9 Minor fix. 2024-04-06 02:51:10 -07:00
3 changed files with 46 additions and 36 deletions

View File

@@ -1,8 +1,8 @@
# Overview
# WiseMapping Open Source
WiseMapping is an open-source web-based mind mapping tool that harnesses the potential of Mind Maps by blending together open standards technologies like SVG and React. It is built upon the foundation of the code supporting http://www.wisemapping.com, ensuring reliability and continuity in its development.
# Compile and Development
# Build and Start Application
The following section describes the steps to check out, compile, and start WiseMapping locally. If you are interested in deploying it, I recommend using the already published images https://hub.docker.com/r/wisemapping/wisemapping.
@@ -19,13 +19,12 @@ The following command line will start WiseMapping locally using HSQLDB in memory
```
$ mvn -f wise-api/pom.xml package
$ docker compose build
$ docker compose up
$ docker compose up --build
```
Application will start at http://localhost/c/login. You can login using *test@wisemapping.org* and password *test*
## Option 2: Start UI and API independently
## Option 2: Start Frontend and Backend API
### Compile and Start API
@@ -35,7 +34,7 @@ $ cd wise-api
$ mvn spring-boot:run
```
## Compile and Start Frontend
### Compile and Start Frontend
You need to checkout https://github.com/wisemapping/wisemapping-frontend first. Then, follow the next steps:
@@ -53,13 +52,12 @@ Application will start at http://localhost:3000/c/login. You can login using *te
# Supportability Matrix
## Supported Databases
## Databases
* MySQL v8 or higher
* PostgreSQL v15 or higher
* Hsqldb v2.7 or higher
# Configuration
WiseMapping backend is based on SpringBoot v3 and it's highly customizable. Additional documentation can be found [here](https://docs.spring.io/spring-boot/3.3/reference/features/external-config.html)

View File

@@ -4,7 +4,7 @@
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.2.4</version>
<version>3.2.5</version>
</parent>
<groupId>org.wisemapping</groupId>
@@ -50,7 +50,7 @@
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>6.1.3</version>
<version>6.1.7</version>
<scope>test</scope>
</dependency>
@@ -109,7 +109,7 @@
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<version>8.3.0</version>
<version>8.4.0</version>
</dependency>
<dependency>
<groupId>org.eclipse.angus</groupId>

View File

@@ -1,10 +1,13 @@
# SpringBoot Configuration ...
server:
tomcat:
remote-ip-header: x-forwarded-for
protocol-header: x-forwarded-proto
#
# This file contains all the defaults that it will be used when the application is started.
# There are two main sections: SpringBoot Config and Application Config
#
#
# SpringBoot Config: WiseMapping Backend is based on SpringBoot. Additional configurations documentation could be found https://docs.spring.io/spring-boot/3.3/reference/features/external-config.html.
#
spring:
# SMTP server configuration used for password recovery and notifications.
mail:
host: smtp.example.com
port: 25
@@ -16,12 +19,7 @@ spring:
connectiontimeout: 5000
timeout: 3000
writetimeout: 5000
output:
ansi:
enabled: always
application:
name: wisemapping-api
title: wisemapping-api
# Database configuration options. Examples can be found: https://github.com/wisemapping/wisemapping-open-source/tree/develop/config/database
datasource:
url: jdbc:hsqldb:mem:wisemapping
driver-class-name: org.hsqldb.jdbc.JDBCDriver
@@ -37,14 +35,24 @@ spring:
default_batch_fetch_size: 200
dialect: org.hibernate.dialect.HSQLDialect
format_sql: true
main:
allow-circular-references: true
sql:
init:
mode: always
platform: hsqldb
# General Config: Do no touch.
main:
allow-circular-references: true
output:
ansi:
enabled: always
application:
name: wisemapping-api
title: wisemapping-api
# Login ...
#
# Log Level
#
logging:
level:
org:
@@ -52,35 +60,32 @@ logging:
tomcat: INFO
root: INFO
# Application Configuration.
#
# Application Config related options:
#
app:
# This information is mainly used by the frontend to connect to the backend. It must match the deployment topology used.
site:
ui-base-url: http://localhost
api-base-url: http://localhost
# Enable API basic authentication.
api:
http-basic-enabled: false
# analytics:
# account:
# JSON Web Token configuration options. Secret must be configured.
jwt:
secret: dlqxKAg685SaKhsQXIMeM=JWCw3bkl3Ei3Tb7LMlnd19oMd66burPNlJ0Po1qguyjgpakQTk2CN3
expirationMin: 10080 # One week
# Admin account with super admin permissions on the API.
admin:
user: admin@wisemapping.org
# STMP email configurations
mail:
sender-email: root@localhost
support-email: root@localhost
enabled: false
accounts:
max-inactive: 20
#######################################################################################
# Google OAuth Authentication
#######################################################################################
# OAuth Client id
#security.oauth2.google.clientId=<config settings>
# OAuth Client secret
#security.oauth2.google.clientSecret=<oauth client>
# Redirect to this url, this url must be configured in the google app {ui-base-url}/c/registration-google
#security.oauth2.google.callbackUrl=<oauth callback url>
security:
# corsAllowedOrigins: https://dev.wisemapping.com
oauth2:
@@ -94,6 +99,7 @@ app:
# accounts:
# exclusion:
# domain:
# Account registration options dialog
registration:
enabled: true
captcha:
@@ -102,3 +108,9 @@ app:
secretKey: some-secret
# Behind reverse proxy configuration
server:
tomcat:
remote-ip-header: x-forwarded-for
protocol-header: x-forwarded-proto