You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds a new user that is passed in the requests entity. The id of the user
69
+
will be returned.
70
+
operationId: addUser
71
+
parameters:
72
+
- in: body
73
+
name: DelphiUser
74
+
description: The user to add
75
+
required: true
76
+
schema:
77
+
type: object
78
+
required:
79
+
- userName
80
+
- secret
81
+
- userType
82
+
properties:
83
+
userName:
84
+
type: string
85
+
example: MyUser
86
+
secret:
87
+
type: string
88
+
example: 123Pass
89
+
userType:
90
+
type: string
91
+
enum:
92
+
- Admin
93
+
- User
94
+
- Component
95
+
responses:
96
+
'200':
97
+
description: OK, user has been added, id is returned
98
+
schema:
99
+
type: integer
100
+
format: int64
101
+
example: 42
102
+
'400':
103
+
description: Bad request, name already exists
27
104
/instances/register:
28
105
post:
29
106
tags:
@@ -374,12 +451,15 @@ paths:
374
451
description: 'Bad request, your label exceeded the character limit'
375
452
'404':
376
453
description: 'Not found, the id you specified could not be found'
377
-
/instances/{Id}/logs:
454
+
'/instances/{Id}/logs':
378
455
get:
379
456
tags:
380
457
- Basic Operations
381
458
summary: Retrieve the logging output of the specified instance
382
-
description: This command retrieves the docker container logging output for the specified instance, if the instance is in fact running inside a docker container.
459
+
description: >-
460
+
This command retrieves the docker container logging output for the
461
+
specified instance, if the instance is in fact running inside a docker
462
+
container.
383
463
operationId: retreiveLogs
384
464
parameters:
385
465
- name: Id
@@ -395,22 +475,28 @@ paths:
395
475
type: boolean
396
476
responses:
397
477
'200':
398
-
description: Success, log string is being returned
478
+
description: 'Success, log string is being returned'
399
479
schema:
400
480
type: string
401
-
example: "I am logging output .."
481
+
example: I am logging output ..
402
482
'400':
403
483
description: Selected instance not running inside docker container
404
484
'404':
405
485
description: Id not found on the server
406
486
'500':
407
487
description: Internal Server Error
408
-
/instances/{Id}/attach:
488
+
'/instances/{Id}/attach':
409
489
get:
410
490
tags:
411
491
- Basic Operations
412
492
summary: Stream logging output from instance
413
-
description: 'This command streams the docker container logging output for the specified instance. NOTE: This is a websocket endpoint, so only valid websocket requests will be processed. Swagger does not provide sufficient support for websockets, so this documentation might be confusing as it defines a HTTP method, etc. The names of parameters and response-codes are valid though.'
493
+
description: >-
494
+
This command streams the docker container logging output for the
495
+
specified instance. NOTE: This is a websocket endpoint, so only valid
496
+
websocket requests will be processed. Swagger does not provide
497
+
sufficient support for websockets, so this documentation might be
498
+
confusing as it defines a HTTP method, etc. The names of parameters and
499
+
response-codes are valid though.
414
500
operationId: streamLogs
415
501
parameters:
416
502
- name: Id
@@ -426,7 +512,7 @@ paths:
426
512
type: boolean
427
513
responses:
428
514
'200':
429
-
description: Success, logs are being streamed via websocket connection.
515
+
description: 'Success, logs are being streamed via websocket connection.'
430
516
'400':
431
517
description: Selected instance not running inside docker container
432
518
'404':
@@ -747,13 +833,12 @@ paths:
747
833
description: One of the ids was not found on the server
748
834
'500':
749
835
description: Internal server error
750
-
/instances/{Id}/command:
836
+
'/instances/{Id}/command':
751
837
post:
752
838
tags:
753
839
- Docker Operations
754
840
summary: Runs a command into a docker container
755
-
description: >-
756
-
This command runs a specified command inside a docker container.
841
+
description: This command runs a specified command inside a docker container.
757
842
operationId: command
758
843
parameters:
759
844
- in: path
@@ -773,23 +858,21 @@ paths:
773
858
properties:
774
859
Command:
775
860
type: string
776
-
example: "rm -rf *"
861
+
example: rm -rf *
777
862
Privileged:
778
863
type: boolean
779
864
User:
780
865
type: string
781
866
example: root
782
867
responses:
783
868
'200':
784
-
description: 'OK'
869
+
description: OK
785
870
'400':
786
-
description: >-
787
-
Cannot run command, ID is no docker container.
871
+
description: 'Cannot run command, ID is no docker container.'
788
872
'404':
789
-
description: Cannot run command, ID not found.
873
+
description: 'Cannot run command, ID not found.'
790
874
'500':
791
-
description: Internal server error, unknown operation result DESCRIPTION
792
-
875
+
description: 'Internal server error, unknown operation result DESCRIPTION'
Copy file name to clipboardExpand all lines: README.md
+13-6Lines changed: 13 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -60,12 +60,19 @@ Before you can start the application, you have to make sure your configuration f
60
60
|```dockerOperationTimeout```|```Timeout```|```Timeout(20 seconds)```| Default timeout for docker operations. If any of the async Docker operations (deploy, stop, pause, ..) takes longer than this, it will be aborted.|
61
61
|```defaultDockerUri```|```String```|```http://localhost:9095```| Default uri to connect to docker. It will be used if the environment variable ```DELPHI_DOCKER_HOST``` is not specified.|
62
62
|```jwtSecretKey```|```String```|```changeme```| Secret key to use for JWT signature (HS256). This setting can be overridden by specifying the ```JWT_SECRET``` environment variable.|
63
-
|```useInMemoryDB```|```Boolean```|```true```| If set to true, all instance data will be kept in memory instead of using a MySQL database.|
64
-
|```databaseHost```|```String```|```"jdbc:mysql://localhost/"```| Host that the MySQL database is reachable at (only necessary if *useInMemoryDB* is false).|
65
-
|```databaseName```|```String```|```""```| Name of the MySQL database to use (only necessary if *useInMemoryDB* is false).|
66
-
|```databaseDriver```|```String```|```"com.mysql.jdbc.Driver"```| Driver to use for the MySQL connection (only necessary if *useInMemoryDB* is false).|
67
-
|```databaseUsername```|```String```|```""```| Username to use for the MySQL connection (only necessary if *useInMemoryDB* is false).|
68
-
|```databasePassword```|```String```|```""```| Password to use for the MySQL connection (only necessary if *useInMemoryDB* is false).|
63
+
|```useInMemoryInstanceDB```|```Boolean```|```true```| If set to true, all instance data will be kept in memory instead of using a MySQL database.|
64
+
|```instanceDatabaseHost```|```String```|```"jdbc:mysql://localhost/"```| Host that the MySQL instance database is reachable at (only necessary if *useInMemoryInstanceDB* is false).|
65
+
|```instanceDatabaseName```|```String```|```""```| Name of the MySQL instance database to use (only necessary if *useInMemoryInstanceDB* is false).|
66
+
|```instanceDatabaseDriver```|```String```|```"com.mysql.jdbc.Driver"```| Driver to use for the MySQL connection (only necessary if *useInMemoryInstanceDB* is false).|
67
+
|```instanceDatabaseUsername```|```String```|```""```| Username to use for the MySQL instance DB connection (only necessary if *useInMemoryInstanceDB* is false).|
68
+
|```instanceDatabasePassword```|```String```|```""```| Password to use for the MySQL instance DB connection (only necessary if *useInMemoryInstanceDB* is false).|
69
+
|```useInMemoryAuthDB```|```Boolean```|```true```| If set to true, all user data will be kept in memory instead of using a MySQL database.|
70
+
|```authDatabaseHost```|```String```|```"jdbc:mysql://localhost/"```| Host that the MySQL users database is reachable at (only necessary if *useInMemoryAuthDB* is false).|
71
+
|```authDatabaseName```|```String```|```""```| Name of the MySQL user database to use (only necessary if *useInMemoryAuthDB* is false).|
72
+
|```authDatabaseDriver```|```String```|```"com.mysql.jdbc.Driver"```| Driver to use for the MySQL users DB connection (only necessary if *useInMemoryAuthDB* is false).|
73
+
|```authDatabaseUsername```|```String```|```""```| Username to use for the MySQL users DB connection (only necessary if *useInMemoryAuthDB* is false).|
74
+
|```authDatabasePassword```|```String```|```""```| Password to use for the MySQL users DB connection (only necessary if *useInMemoryAuthDB* is false).|
75
+
|```authenticationValidFor```|```Int```|```30```| Default duration that user tokens are valid for (in minutes).|
69
76
|```maxTotalNoRequest```|```Int```|```2000```| Maximum number of requests that are allowed to be executed during the current refresh period regardless of their origin.|
70
77
|```maxIndividualIpReq```|```Int```|```200```| Maximum number of requests that are allowed to be executed during the current refresh period for one specific origin ip.|
71
78
|```ipLogRefreshRate```|```FiniteDuration```|```2.minutes```| Duration of the log refresh period.|
0 commit comments