Configure the Administration API¶
This configuration is part of Firely Server settings.
"Administration": {
"Repository": "SQLite", //Memory / SQL / MongoDb
"MongoDbOptions": {
"ConnectionString": "mongodb://localhost/vonkadmin",
"EntryCollection": "vonkentries"
},
"SqlDbOptions": {
"ConnectionString": "connectionstring to your Firely Server Admin SQL Server database (SQL2012 or newer); Set MultipleActiveResultSets=True",
"SchemaName": "vonkadmin",
"AutoUpdateDatabase": true
//"AutoUpdateConnectionString" : "set this to the same database as 'ConnectionString' but with credentials that can alter the database. If not set, defaults to the value of 'ConnectionString'"
},
"SQLiteDbOptions": {
"ConnectionString": "Data Source=./data/vonkadmin.db",
"AutoUpdateDatabase": true
},
"Security": {
"AllowedNetworks": [ "::1" ], // i.e.: ["127.0.0.1", "::1" (ipv6 localhost), "10.1.50.0/24", "10.5.3.0/24", "31.161.91.98"]
"OperationsToBeSecured": [ "reindex", "reset", "preload" ]
}
},
Choosing your storage¶
Repository
: Choose which type of repository you want. Valid values are:
- Memory
- SQL
- SQLite
- MongoDb
MongoDbOptions
: Use these with"Repository": "MongoDb"
, see Using MongoDB for details.SqlDbOptions
: Use these with"Repository": "SQL"
, see Using SQL server for details.SQLiteDbOptions
: Use these with"Repository": "SQLite"
, see Using SQLite for details.
Limited access¶
Security
: You can restrict access to the operations listed inOperationsToBeSecured
to only be invoked from the IP addresses listed inAllowedNetworks
.
- Operations that can be secured are:
reindex
(see Re-indexing for new or changed SearchParameters)reset
(see Reset the database)preload
(see Preloading a set of resources)- Read / write on the Conformance resources of type:
StructureDefinition
SearchParameter
ValueSet
CodeSystem
CompartmentDefinition
Subscription
: all the read and write on /Subscription (see Subscriptions)- The
AllowedNetworks
have to be valid IP addresses, either IPv4 or IPv6, and masks are allowed.