[[system_configuration]] == Configuration System default settings for Helix Web Services can be set by creating a YAML file at `/etc/perforce/helix_web_services.conf`. If you're unfamiliar with YAML, you simply use the variables below in simple key-value pairs. Pay attention, however, to the type of the variable. In many cases we use strings when you might have thought it were a number. For example: /etc/perforce/helix_web_services.conf ---- P4PORT: 'perforce.mycompany.com:1999' ---- Many settings in Helix Web Services are overridable by HTTP headers on a per-request basis. The "Overridable" column in the table below means you can specify this header. If it is not available, you can _only_ specify the configuration in the system config file. For more information on specifying the system header, see <<per_request_configuration>>. [cols="5*", options="header"] |=== | Variable | Type | Overridable | Description | Default | `COMMAND_WHITELIST` | Array | No | Allows access to run commands via <<get_helix_versioning_engine_vX_commands_command>> or <<post_helix_versioning_engine_vX_commands_command>>. Each element in the array is either the name of a command to allow, or an array of the command name and any required arguments. | `["info", ["files", "-m"]]` | `ENABLE_HELIX_CLOUD_AUTH` | Boolean | No | Use Helix Cloud as the authentication source. | false | `ENABLE_HELIX_CLOUD_PROJECTS` | Boolean | No | Enable Helix Cloud as a project source. | false | `HVE_PROJECTS_PATH` | String | Yes | The depot location in the Helix Versioning Engine that hosts all projects in that server. | | `P4HOST` | String | Yes | The hostname for the perforce server, e.g., `perforce.example.com` | | `P4PORT` | String | Yes | The port number (or port and hostname combination) that indicates our Perforce connection | `1666` | `P4CHARSET` | String | Yes | The charset value for P4 connections. Set to `none` if you are connecting to a non-unicode server. | `auto` | `SERVICE_CONFIGURATION` | String | No | Local file location that defines how services are to be configured. | `/etc/perforce/services.json` | `WORKSPACE_DIR` | String | No | The local directory used for generating temporary Perforce Client Workspaces to do some basic operations. | `/var/lib/perforce/helix_web_services/workspaces` |===
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 15741 | ptomiak | Branch HWS for my use. | ||
//guest/perforce_software/helix-web-services/main/source/doc/03_configuration.asc | |||||
#1 | 15622 | tjuricek |
Move source code to 'source/' subdirectory of branch. build/ will remain where it is. |
||
//guest/perforce_software/helix-web-services/main/doc/03_configuration.asc | |||||
#11 | 15545 | tjuricek | Place in config and hooks for Helix Cloud authentication. | ||
#10 | 15483 | tjuricek |
Add a new 'hws_console` application to the deployment. This should give users the ability to use the Ruby client for quick and dirty debugging of issues with HWS. Since it's so easy, I've added it to the deployment guide. |
||
#9 | 15437 | tjuricek |
Basic "HVE Project" implementation. This will allow directories in a HVE instance to host 'projects' for use by helix sync. There are no methods defined for creating the projects, however. This does not include any specialization or testing in the Qt API yet. I may investigate creating a "higher level" interface for Qt client apps. |
||
#8 | 15297 | tjuricek |
Implement of 'cluster services' configuration. The configuration will be stored in a local JSON file, which is expected to be maintained by the systems admin. Eventually, it's expected to have this sort of thing implemented via Helix Admin. |
||
#7 | 15257 | tjuricek |
Added stress test, corrected per-request header config. Apparently using underscores is a "special" mechanism for HTTP headers, and requires adjusting nginx to allow such things. Might as well just recommend using hyphens, which get converted to underscores anyway. The current test just hits a listing of 20000 files against p4play. Returns a 2.5 MB response, which doesn't seem to cause problems (yay). |
||
#6 | 15240 | tjuricek |
Set api level via request path on all Helix Versioning Engine methods. This will allow migration of applications to different P4D versions. Our internal methods (like project API) should attempt to handle backward compatibility similarly. P4WEBAPI-118 |
||
#5 | 15229 | tjuricek | Remove incorrect default setting for P4HOST | ||
#4 | 15208 | tjuricek |
Revise 'command' implementation, tests, and documentaiton. This includes a change from a command blacklist to a whitelist. See P4WEBAPI-21 |
||
#3 | 15110 | tjuricek | Revise changes methods for new p4 connection handling, add server specs, remove model references in client, and update asciidoc documentation. | ||
#2 | 15090 | tjuricek |
Update _proposed_ API for project services. This is *very likely* to change, and will not be implemented until reviewed. |
||
#1 | 15038 | tjuricek | Document 'login' auth method and client programming overview. |