{"_id":"55dc767d55be9f21004ee251","parentDoc":null,"githubsync":"","project":"55db8f8f1a91690d007ad975","__v":18,"user":"55dc702d7fa0290d00559106","version":{"_id":"55db8f901a91690d007ad978","project":"55db8f8f1a91690d007ad975","__v":17,"createdAt":"2015-08-24T21:41:36.034Z","releaseDate":"2015-08-24T21:41:36.034Z","categories":["55db8f901a91690d007ad979","55db9856b3d6540d00886426","55dc751b00a8811900c230e3","55dc766255be9f21004ee250","55dc769200a8811900c230ed","55e4c701177b6e0d003330fa","55f4915caf0bc71900a53130","55f491b2be9c2b2100f0635d","560b22739c7be70d00100bd8","57488c53e8c6a420000b729c","574cefd95953e20e00f40f9f","5798edfd7700d30e00ad250c","579ac88234b5fd0e00b9e140","57c81c6d690c200e0047b72e","57d9b8fbda17c30e003897f1","57d9b90e608ea00e00f358d8","57d9b91cda17c30e003897f4"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"560b22739c7be70d00100bd8","pages":["560b229caf40a70d003df309","56bcb2cf9afb8b0d00d62df6"],"project":"55db8f8f1a91690d007ad975","version":"55db8f901a91690d007ad978","__v":2,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-29T23:44:51.456Z","from_sync":false,"order":6,"slug":"advanced-configurations","title":"Advanced configurations"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-25T14:06:53.030Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"agent_enabled\"\n}\n[/block]\nThis setting allows for disabling the agent without removing it from the app's dependencies. To disable the agent, set the value to `false`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"agent_enabled: false\",\n      \"language\": \"yaml\",\n      \"name\": \"immunio.yml (Ruby)\"\n    },\n    {\n      \"code\": \"[immunio]\\nagent_enabled = false\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.ini (Python)\"\n    },\n    {\n      \"code\": \"agentEnabled = false\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.properties (Java)\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"key\"\n}\n[/block]\nThe **key** credential for the app. Credentials may be managed from the *Settings* page in the dashboard.\n\nThis setting is not optional.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"key: 87637d4f-f01a-406d-b3e6-1ff8f84a3d34\",\n      \"language\": \"yaml\",\n      \"name\": \"immunio.yml (Ruby)\"\n    },\n    {\n      \"code\": \"[immunio]\\nkey = 87637d4f-f01a-406d-b3e6-1ff8f84a3d34\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.ini (Python)\"\n    },\n    {\n      \"code\": \"key = 87637d4f-f01a-406d-b3e6-1ff8f84a3d34\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.properties (Java)\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"secret\"\n}\n[/block]\nThe **secret** credential for the app. Credentials may be managed from the *Settings* page in the dashboard.\n\nThis setting is not optional. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"secret: a0ca4263-da57-45f5-aabb-b72e5a78b510\",\n      \"language\": \"yaml\",\n      \"name\": \"immunio.yml (Ruby)\"\n    },\n    {\n      \"code\": \"[immunio]\\nsecret = a0ca4263-da57-45f5-aabb-b72e5a78b510\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.ini (Python)\"\n    },\n    {\n      \"code\": \"secret = a0ca4263-da57-45f5-aabb-b72e5a78b510\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.properties (Java)\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"log_file\"\n}\n[/block]\nThe path to the agent log file, which is by default located in your project directory under `log/immunio.log`. You may also set the setting to `STDOUT` or `STDERR` to redirect logging to those locations.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"log_file: /path/to/immunio.log\",\n      \"language\": \"yaml\",\n      \"name\": \"immunio.yml (Ruby)\"\n    },\n    {\n      \"code\": \"[immunio]\\nlog_file = /path/to/immunio.log\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.ini (Python)\"\n    },\n    {\n      \"code\": \"logFile = /path/to/immunio.log\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.properties (Java)\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"log_level\"\n}\n[/block]\nThe level of logging from the agent, which is by default `info`. This can be set to one of the following levels:\n* error​\n* warn\n* info\n* debug\n* trace\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"log_level: trace\",\n      \"language\": \"yaml\",\n      \"name\": \"immunio.yml (Ruby)\"\n    },\n    {\n      \"code\": \"[immunio]\\nlog_level = trace\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.ini (Python)\"\n    },\n    {\n      \"code\": \"logLevel = trace\",\n      \"language\": \"toml\",\n      \"name\": \"immunio.properties (Java)\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"proxy settings\"\n}\n[/block]\nThe configuration for the Immunio agent to connect to the backend services via a proxy\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# Net::HTTP will automatically create a proxy from the http_proxy environment\\n# variable if it is present.\\nENV['http_proxy'] = 'http://<IP/host>:<port>' \",\n      \"language\": \"text\",\n      \"name\": \"Ruby\"\n    },\n    {\n      \"code\": \"httpProxyHost = <host name>\\nhttpProxyPort = <port>\",\n      \"language\": \"java\",\n      \"name\": \"immunio.properties (Java)\"\n    },\n    {\n      \"code\": \"<configuration>\\n  <appSettings>\\n    <!-- Use an HTTP proxy to connect to immun.io -->\\n    <add key=\\\"Immunio:HttpProxyHost\\\" value=\\\"my-proxy.com\\\" />\\n    <add key=\\\"Immunio:HttpProxyPort\\\" value=\\\"3128\\\" />\\n  </appSettings>\\n</configuration>\",\n      \"language\": \"xml\",\n      \"name\": \"Web.config (.NET)\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"agent_settings","type":"basic","title":"Agent Settings"}
[block:api-header] { "type": "options", "title": "agent_enabled" } [/block] This setting allows for disabling the agent without removing it from the app's dependencies. To disable the agent, set the value to `false`. [block:code] { "codes": [ { "code": "agent_enabled: false", "language": "yaml", "name": "immunio.yml (Ruby)" }, { "code": "[immunio]\nagent_enabled = false", "language": "toml", "name": "immunio.ini (Python)" }, { "code": "agentEnabled = false", "language": "toml", "name": "immunio.properties (Java)" } ] } [/block] [block:api-header] { "type": "options", "title": "key" } [/block] The **key** credential for the app. Credentials may be managed from the *Settings* page in the dashboard. This setting is not optional. [block:code] { "codes": [ { "code": "key: 87637d4f-f01a-406d-b3e6-1ff8f84a3d34", "language": "yaml", "name": "immunio.yml (Ruby)" }, { "code": "[immunio]\nkey = 87637d4f-f01a-406d-b3e6-1ff8f84a3d34", "language": "toml", "name": "immunio.ini (Python)" }, { "code": "key = 87637d4f-f01a-406d-b3e6-1ff8f84a3d34", "language": "toml", "name": "immunio.properties (Java)" } ] } [/block] [block:api-header] { "type": "options", "title": "secret" } [/block] The **secret** credential for the app. Credentials may be managed from the *Settings* page in the dashboard. This setting is not optional. [block:code] { "codes": [ { "code": "secret: a0ca4263-da57-45f5-aabb-b72e5a78b510", "language": "yaml", "name": "immunio.yml (Ruby)" }, { "code": "[immunio]\nsecret = a0ca4263-da57-45f5-aabb-b72e5a78b510", "language": "toml", "name": "immunio.ini (Python)" }, { "code": "secret = a0ca4263-da57-45f5-aabb-b72e5a78b510", "language": "toml", "name": "immunio.properties (Java)" } ] } [/block] [block:api-header] { "type": "options", "title": "log_file" } [/block] The path to the agent log file, which is by default located in your project directory under `log/immunio.log`. You may also set the setting to `STDOUT` or `STDERR` to redirect logging to those locations. [block:code] { "codes": [ { "code": "log_file: /path/to/immunio.log", "language": "yaml", "name": "immunio.yml (Ruby)" }, { "code": "[immunio]\nlog_file = /path/to/immunio.log", "language": "toml", "name": "immunio.ini (Python)" }, { "code": "logFile = /path/to/immunio.log", "language": "toml", "name": "immunio.properties (Java)" } ] } [/block] [block:api-header] { "type": "options", "title": "log_level" } [/block] The level of logging from the agent, which is by default `info`. This can be set to one of the following levels: * error​ * warn * info * debug * trace [block:code] { "codes": [ { "code": "log_level: trace", "language": "yaml", "name": "immunio.yml (Ruby)" }, { "code": "[immunio]\nlog_level = trace", "language": "toml", "name": "immunio.ini (Python)" }, { "code": "logLevel = trace", "language": "toml", "name": "immunio.properties (Java)" } ] } [/block] [block:api-header] { "title": "proxy settings" } [/block] The configuration for the Immunio agent to connect to the backend services via a proxy [block:code] { "codes": [ { "code": "# Net::HTTP will automatically create a proxy from the http_proxy environment\n# variable if it is present.\nENV['http_proxy'] = 'http://<IP/host>:<port>' ", "language": "text", "name": "Ruby" }, { "code": "httpProxyHost = <host name>\nhttpProxyPort = <port>", "language": "java", "name": "immunio.properties (Java)" }, { "code": "<configuration>\n <appSettings>\n <!-- Use an HTTP proxy to connect to immun.io -->\n <add key=\"Immunio:HttpProxyHost\" value=\"my-proxy.com\" />\n <add key=\"Immunio:HttpProxyPort\" value=\"3128\" />\n </appSettings>\n</configuration>", "language": "xml", "name": "Web.config (.NET)" } ] } [/block]