[{"_1":2,"_182":-5,"_183":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_161":162},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_89":90,"_111":112,"_150":-5,"_151":11,"_152":21,"_153":11,"_154":-5,"_155":11,"_156":-5,"_157":158,"_159":113,"_160":-7},"canonicalUrl","https://hub.docker.com/r/seclore/sdk-api-server/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","seclore","reponame","sdk-api-server","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":73,"_74":75,"_80":11,"_81":82,"_86":33,"_87":88},"categories",[],"content_types",[44],"image","date_registered","2024-08-09T05:13:14.957702Z","description","A containerized environment for running the Seclore SDK APIs.","is_private","last_updated","2024-08-22T14:55:31.737269Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",84,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","\n# Seclore SDK API Server\n---\n## Table of Contents\n1. [Overview](#Overview)\n2. [Features](#Features)\n3. [Usage](#Usage)\n4. [Environment Variables](#Configuration) \n\n---\n\n## Overview \n\nThe Seclore SDK API Server Docker image provides a containerized environment for running the Seclore SDK API. This image includes all the necessary components to deploy and manage the API server efficiently.\n\n---\n## Features \n- **SpringDoc Swagger UI**: Swagger UI is enabled for API documentation and testing.\n- **Configurable Logging and Memory**: Adjust logging level and Java memory settings as needed.\n- **Customizable Environment**: Configure various application settings via environment variables.\n\n---\n## Usage \n\nSet the required [Environment Variables](#Configuration) and run the container\n> **_NOTE_** : As Linux Environment doesnt allow square brackets('[' and ']') in environment key names. So set the environment configurations in a `.env` file and use the provided command with\n> additional flag : `--env-file `\n\nTo run the container, replace the following placeholders with their requested values in the provided [command](#docker_run_command) and execute it:\n- `` with the your host machine port.\n- `` with path to the file storage preferably a NAS.\n\n#### Command:\n```bash\ndocker run -p :8443 -v :/app/data seclore/sdk-api-server:\n```\n\nNow, access the following Swagger Docs URL to view the API documentation(available only if Swagger UI is enabled):\n`http://:/swagger-ui.html`\n\nApplication logs can be viewed on console.\n\n\n> **_NOTE:_** Create a `seclore` user with id `54321` in host machine and provide it with read, write and execute permission on the `` using following command:\n> ```bash \n> groupadd -g 54321 seclore && \\\n> useradd -u 54321 seclore -g seclore && \\\n> chown -R seclore:seclore && \\\n> chmod -R 755 \n> ```\n\n\n---\n## Environment Variables \n\nThe image uses several environment variables which are easy to miss. The only variables required are `app.fshelper[n].identifier` and `app.fshelper[n].config`, the rest are optional. Here are some key options:\n\n- `APPLICATION_LOG_LEVEL`: Set the log level (default is `info`).\n- `ENABLE_BC_FIPS`: Enable or disable BC FIPS mode (default is `false`).\n- `JAVA_MIN_MEMORY`: Minimum Java memory allocation in MB (default is `1024`).\n- `JAVA_MAX_MEMORY`: Maximum Java memory allocation in MB (default is `2048`).\n- `springdoc.swagger-ui.enabled`: Enable/Disable Swagger UI for API documentation and testing by setting it as `true` or `false` (default is `true`).\n- `app.fshelper[n].identifier`: Unique identifier for FS helper. This will help identify which configuration to use for Seclore APIs. \n> **_NOTE:_** 'n' represents an integer(starting from `0` to `n`) for linking a FSHelper identifier with a FSHelper config.\n- `app.fshelper[n].config`: Base64 encoded configuration settings for FS helper. Refer the [FSHelper Configuration](#FSHelper-Configuration) for generating this configuration.\n\n#### Configurations for Advanced EA\n- `app.fshelper[n].privateKey`: Private key in xml. The value should be in hexadecimal format.\n- `app.fshelper[n].keyId`: A unique Id which is mapped to the public key part on Policy Server.\n- `app.fshelper[n].keyLength`: Length of the private Key.(Example - `256`)\n- `app.fshelper[n].padding`: Padding to be used for encrypt or decrypt.(Example - `PKCS1Padding`)\n- `app.fshelper[n].chainingMode`: Chaining mode to be used for encrypt or decrypt.(Example - `ECB`)\n\n### FSHelper Configuration \nFill the below [config xml](#config-xml) and convert it to Base64 encoded value(using any Base64 encoding tool such as ) for `app.fshelper[n].config`\n\n\n#### Config xml \n```xml\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n\t\n\t\n\t\t\n\t\t1\n\n\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\tfalse\n\t\t\n\t\t\n\t\n \n \n false\n \n\t\n\ten\n\t\n \n \n \n 50\n \n 900\n \n\n \n \n \n \n \n \n \n \n \n\n```","has_starred","hub_user","devsoftseclore","immutable_tags_settings",{"_76":11,"_77":78},"enabled","rules",[79],".*","is_automated","permissions",{"_83":21,"_84":11,"_85":11},"read","write","admin","user","storage_size",329660784,"orgData",{"_91":92,"_93":94,"_95":96,"_97":33,"_98":99,"_100":101,"_102":99,"_103":104,"_105":106,"_107":101,"_108":101,"_109":101,"_110":21},"id","53d27811a2884252acefec6814daf89c","uuid","53d27811-a288-4252-acef-ec6814daf89c","type","organization","orgname","full_name","Seclore Technology PVT LTD","location","","company","profile_url","https://www.seclore.com","date_joined","2020-06-23T07:01:51Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[113],{"_114":44,"_115":116,"_117":118,"_119":120,"_91":121,"_122":123,"_50":138,"_139":116,"_140":141,"_142":56,"_57":143,"_144":145,"_146":129,"_147":138,"_148":66,"_149":21},"content_type","creator",11918226,"digest","sha256:606459152b24eb4a62d3e2a1de12c269e948d53dad6af21649fe5b4a78f097cd","full_size",150301114,736513410,"images",[124],{"_125":126,"_117":118,"_127":101,"_128":129,"_130":131,"_132":133,"_134":101,"_135":-5,"_136":120,"_63":66,"_137":-5},"architecture","amd64","features","last_pulled","2026-10-02T22:54:36.732466747Z","last_pushed","2024-08-22T14:49:46Z","os","linux","os_features","os_version","size","variant","2024-08-22T14:55:31.472696Z","last_updater","last_updater_username","secloredevadmin","media_type","3.0.0.0","repository",24839768,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":163,"_170":171,"_157":180,"_181":11},{"_40":164,"_42":165,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":166,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":73,"_74":167,"_80":11,"_81":169,"_86":33,"_87":88},[],[44],[56],{"_76":11,"_77":168},[79],{"_83":21,"_84":11,"_85":11},"tags",{"_172":64,"_173":-5,"_174":-5,"_175":176},"count","next","previous","results",[177],{"_114":44,"_115":116,"_117":118,"_119":120,"_91":121,"_122":178,"_50":138,"_139":116,"_140":141,"_142":56,"_57":143,"_144":145,"_146":129,"_147":138,"_148":66,"_149":21},[179],{"_125":126,"_117":118,"_127":101,"_128":129,"_130":131,"_132":133,"_134":101,"_135":-5,"_136":120,"_63":66,"_137":-5},[],"canDeleteTags","actionData","errors"]

seclore/sdk-api-server

Tags for seclore/sdk-api-server