Skip to content
This repository was archived by the owner on Nov 28, 2022. It is now read-only.

Commit 4b3b223

Browse files
committed
new file for project settings and its location in TOC
Signed-off-by: Jacob Berger <jacob.berger@ibm.com>
1 parent bd885e6 commit 4b3b223

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

docs/_data/docstoc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@
7373
url: checkingstatuses.html
7474
- title: 'Importing existing projects'
7575
url: importing-existing-projects.html
76+
- title: 'Project settings'
77+
url: project-settings.html
7678

7779
- title: 'Performance monitoring'
7880
children:
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
layout: docs
3+
title: Project settings
4+
description: Project settings tell Codewind the specifics of your project and application
5+
keywords: project, settings, Codewind, application, configuring, workspace
6+
duration: 1 minute
7+
permalink: project-settings
8+
type: document
9+
order: 4
10+
parent: developing-projects
11+
---
12+
13+
# Project settings
14+
15+
Project settings tell Codewind more about the specifics of your project and can affect the status or behavior of your application. Project settings can be configured from the `Project Overview` page that is accessible from a project's context menu. You can also find the project settings in the `.cw-settings` file of the project which you can edit from the IDE. The workspace automatically picks up changes to these fields.
16+
17+
Supported project settings include:
18+
* [Context root](#context-root)
19+
* [Health check endpoint](#health-check-endpoint)
20+
* [HTTPS application](#https-application)
21+
* [Internal application port](#internal-application-port)
22+
* [Internal debug port](#internal-debug-port)
23+
* [Maven profiles](#maven-profiles)
24+
* [Maven properties](#maven-properties)
25+
* [Paths to ignore for file changes](#paths-to-ignore-for-file-changes)
26+
* [Project status ping timeout](#project-status-ping-timeout)
27+
28+
## **Context root**
29+
`contextRoot: <string>`
30+
- Codewind uses the value to determine the project state.
31+
- When the Open Application action is used, it uses the value as the initial endpoint.
32+
- If an incorrect context root is set, the project is stuck in the starting state.
33+
- If the health check endpoint is set, the context root is not used to determine the project state.
34+
- If the value is not set, the default value is `/`.
35+
36+
## **Health check endpoint**
37+
`healthCheck: <string>`
38+
- Codewind uses the value to determine the project state.
39+
- Codewind expects to use this value for the application health check endpoint.
40+
- If a wrong health check endpoint is set, the project is stuck in the starting state.
41+
- If the health check endpoint is set, the context root is not used to determine the project state.
42+
43+
## HTTPS application
44+
`isHttps: <boolean>`
45+
- This value tells Codewind to use the HTTPS protocol when Codewind detects the application status, and also when Codewind launches the application in a browser.
46+
- If your application supports HTTPS, set `isHttps` to `true`, and Codewind uses HTTPS instead of HTTP to detect the application status and to open browser URLs.
47+
- The default value of this setting is `false`.
48+
49+
## **Internal application port**
50+
`internalPort: <string>`
51+
- When exposed, Codewind does not automatically expose the port.
52+
- Codewind uses the value in conjunction with the context root to determine the project state.
53+
- If an incorrect port is set, the project is stuck in starting state.
54+
55+
## **Internal debug port**
56+
`internalDebugPort: <string>`
57+
- Only applicable to Microprofile, Spring and Node.js projects.
58+
- Only applicable to a local installation of Codewind.
59+
- Can be assigned to a non-exposed port, then Codewind helps expose the port for you.
60+
- If the project is already in debug mode, restart the project in debug mode in order to pick up the new debug port.
61+
- If the project is in run mode, the next restart picks up and uses the new debug port and completes a debug mode.
62+
63+
## **Paths to ignore for file changes**
64+
`ignoredPaths: <string[]>`
65+
- A list of file paths that indicate a build must be triggered on file change events in relation to the paths.
66+
- Each item is expected to be a regex (`"*/node_modules*"` ) or a path relative to the project's root directory (`"/README.md"`).
67+
68+
## **Maven profiles**
69+
`mavenProfiles: <string[]>`
70+
- Only applicable to Microprofile and Spring projects.
71+
- Set a list of profiles if your project requires to use additional Maven profiles when Codewind issues Maven commands.
72+
- Do not overwrite nor remove the microclimate profile.
73+
- Maven profiles can be used in conjunction with Maven properties.
74+
75+
## **Maven properties**
76+
`mavenProperties: <string[]>`
77+
- Only for Microprofile and Spring projects.
78+
- Maven properties can be entered in the form `key=value`.
79+
- Do not overwrite the microclimate property.
80+
- Maven properties can be used in conjunction with Maven profiles.
81+
82+
## Project status ping timeout
83+
`statusPingTimeout: <string>`
84+
- This value is the total number of pings used by Codewind to determine if the project has timeout issues during the starting state.
85+
- Each ping takes 2 seconds. For example, if the value is set to 30 seconds, the timeout is 60 seconds.
86+
- If the value is not set, the default value is set to `90` (3 minutes) for Appsody projects, and `30` (1 minute) for all other project types.

0 commit comments

Comments
 (0)