{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"},"minLevel":{"value":"2"},"type":{"value":"flat"}},"macroMetadata":{"macroId":{"value":"cd625d07-f50c-4fa0-b569-6fb03875bb4d"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"2a265dc6-4501-4faf-8029-961a7cb5b921"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Service description","type":"text"}]},{"type":"paragraph","content":[{"text":"GitHub","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/"}}]},{"text":" is a web-based platform used for version control. Git simplifies the process of working with other people and makes it easy to collaborate on projects. Team members can work on files and easily merge their changes with the master branch of the project.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Data source description","type":"text"}]},{"type":"paragraph","content":[{"text":"The GitHub API provides all the information about a code repository hosted with them, from commits to pull requests and comments.","type":"text"}]},{"type":"paragraph","content":[{"text":"Listed below are the resources that can be sent to Devo:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"840bd494-dfe0-43e4-b2e7-5c7a0dcf79d3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Service","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Resource","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"Devo tables","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Collaborators","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Information about the repository collaborators","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.collaborators","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Commits","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Commits made in the repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.commits","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Forks","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Forks created in the repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.forks","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Events","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Information about the different events, such as resource creations or deletions","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.events","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Issue comments","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Comments made in every issue","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.issue_comments","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Subscribers","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Information about the different users subscribed to one repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.subscribers","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Pull requests","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Pull requests made in the repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.pull_requests","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Subscriptions","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Repositories you are subscribed","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.subscriptions","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Releases","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Information about releases made in the repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.releases","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Stargazers","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Information about the users who “starts” repositories making them favorites","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.repository.stargazers","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Organization","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Audit","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Organization auditory events","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.organization.audit","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Organization","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"SSO Authorizations","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Single sign-on authorization","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.organization.sso_authorizations","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[172.38]},"content":[{"type":"paragraph","content":[{"text":"Organization","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[176.78]},"content":[{"type":"paragraph","content":[{"text":"Webhooks","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[571.73]},"content":[{"type":"paragraph","content":[{"text":"Organization created webhooks","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.32]},"content":[{"type":"paragraph","content":[{"text":"vcs.github.organization.webhooks","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Learn more about the","type":"text"},{"text":" vcs.github","type":"text","marks":[{"type":"strong"}]},{"text":" data tables here.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Setup","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Getting the required credentials","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to your GitHub account. This account needs to be the main or principal account that controls all GitHub.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to","type":"text"},{"text":" Settings → Developer settings → Personal access tokens ","type":"text","marks":[{"type":"strong"}]},{"text":"and click","type":"text"},{"text":" Generate new token","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":45.0},"content":[{"type":"media","attrs":{"width":1233,"id":"6438a163-e1af-459e-978f-32acb68e397a","collection":"contentId-94638440","type":"file","height":544}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check the following options and click ","type":"text"},{"text":"Generate token","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":30.0},"content":[{"type":"media","attrs":{"width":577,"id":"a5c2f409-03b9-4d3f-92e8-6ed0b4fcc051","collection":"contentId-94638440","type":"file","height":750}}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Run the collector","type":"text"}]},{"type":"paragraph","content":[{"text":"Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (","type":"text"},{"text":"Cloud collector","type":"text","marks":[{"type":"underline"}]},{"text":"), or deploy and host the collector in your own machine using a Docker image (","type":"text"},{"text":"On-premise collector","type":"text","marks":[{"type":"underline"}]},{"text":").","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-tabs-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"56db78a8-15ee-4474-a8aa-e7619993f66b"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tabs.png"}}],"title":"UI Tabs"}},"localId":"28335398-4b5d-4e27-8eb4-e15087cf5a5c"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"Cloud collector"}},"macroMetadata":{"macroId":{"value":"bb30b91db9a5fed542b58d8d742c19dc"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"e07ffaa0-9d63-4da3-b7f9-7df30d227872"}},{"type":"paragraph","content":[{"text":"We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, ","type":"text"},{"text":"get in touch with us","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:support@devo.com"}}]},{"text":" and we will guide you through the configuration.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"On-premise collector"}},"macroMetadata":{"macroId":{"value":"7e7bfed65d41805eee2e44480b05a817"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"df688a4c-e325-498c-8f5d-59a2bb14bb76"}},{"type":"paragraph","content":[{"text":"This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Structure","type":"text"}]},{"type":"paragraph","content":[{"text":"The following directory structure should be created for being used when running the GitHub collector:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n└── devo-collectors/\n └── github/\n ├── certs/\n │ ├── chain.crt\n │ ├── .key\n │ └── .crt\n └── config/\n └── config-github.yaml","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Devo credentials","type":"text"}]},{"type":"paragraph","content":[{"text":"In Devo, go to ","type":"text"},{"text":"Administration → Credentials → X.509 Certificates","type":"text","marks":[{"type":"strong"}]},{"text":", download the ","type":"text"},{"text":"Certificate","type":"text","marks":[{"type":"strong"}]},{"text":", ","type":"text"},{"text":"Private key","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"Chain CA","type":"text","marks":[{"type":"strong"}]},{"text":" and save them in ","type":"text"},{"text":"/devo-collectors/github/certs","type":"text","marks":[{"type":"code"}]},{"text":". Learn more about security credentials in Devo ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/pages/createpage.action?spaceKey=NDT5&title=Security%20credentials"}}]},{"text":".","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1822,"id":"8cd85454-3546-4f00-a793-3c1cfe461946","collection":"contentId-94638440","type":"file","height":471}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Editing the config-github.yaml file","type":"text"}]},{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"config-github.yaml","type":"text","marks":[{"type":"strong"}]},{"text":" file, replace the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" values and enter the ones that you got in the previous steps. In the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" placeholder, enter the value that you choose.","type":"text"}]},{"type":"codeBlock","content":[{"text":"globals:\n debug: false\n id: not_used\n name: github\n persistence:\n type: filesystem # File system persistence ON\n config:\n directory_name: state # Directory where the persistence will be saved in case of using filesystem\noutputs:\n devo_1: # Cloud Devo config EU (for US use us.elb.relay.logtrust.net)\n type: devo_platform\n config:\n address: eu.elb.relay.logtrust.net\n port: 443\n type: SSL\n chain: chain.crt\n cert: .crt\n key: .key\ninputs:\n github:\n id: \n enabled: true\n services:\n repository:\n resources: # Resource List to collect data\n - commits\n - forks\n - issue_comments\n - collaborators\n - events\n - pull_requests\n - releases\n - stargazers\n - subscribers\n - subscriptions\n credentials:\n hostname: 'https://api.github.com/' # Github Enterprise server IP or 'https://api.github.com/' for github.com\n token: '' # Github token\n username: '' # Github user name\n org: '' # Github organization name\n pager: 2 # Retrieving pager. Modify only to optimize performance\n organization:\n resources: # Resource List to collect data\n - audit\n - sso_authorizations\n - webhooks\n credentials:\n hostname: 'https://api.github.com/' # Github Enterprise server IP or 'https://api.github.com/' for github.com\n token: '' # Github token\n username: '' # Github user name\n org: '' # Github organization name\n pager: 2 # Retrieving pager. Modify only to optimize performance","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Download the Docker image","type":"text"}]},{"type":"paragraph","content":[{"text":"The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"2f3573e5-65ae-491e-920b-ee6cca0a2ca1"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Collector Docker image","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"SHA-256 hash","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"collector-github-docker-image-1.2.2.tgz","type":"text","marks":[{"type":"link","attrs":{"href":"https://drive.google.com/file/d/1rELaY__Fr1TYYb5WkRGNhS-bzJSSjyKu/view?usp=sharing"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"d9f2aecd615857b92166d5ed803df7d74d41da383dc68df5057596016958c70a","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Use the following command to add the Docker image to the system:","type":"text"}]},{"type":"codeBlock","content":[{"text":"$ gunzip -c collector-github-docker-image-.tgz | docker load","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace \"","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":"\" with a proper value.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The Docker image can be deployed on the following services:","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Docker","type":"text"}]},{"type":"paragraph","content":[{"text":"Execute the following command on the root directory ","type":"text"},{"text":"/devo-collectors/github/","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","content":[{"text":"docker run \\\n--name collector-github \\\n--volume $PWD/certs:/devo-collector/certs \\\n--volume $PWD/config:/devo-collector/config \\\n--volume $PWD/state:/devo-collector/state \\\n--env CONFIG_FILE=config-github.yaml \\\n--rm -it docker.devo.internal/collector/github_collector:","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":" Replace \"","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":"\" with a proper value.","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Docker Compose","type":"text"}]},{"type":"paragraph","content":[{"text":"The following Docker Compose file can be used to execute the Docker container. It must be created in the ","type":"text"},{"text":"/devo-collectors/github/","type":"text","marks":[{"type":"code"}]},{"text":" directory.","type":"text"}]},{"type":"codeBlock","content":[{"text":"version: '3'\nservices:\n github_collector:\n build:\n context: .\n dockerfile: Dockerfile\n image: docker.devo.internal/collector/github_collector:${IMAGE_VERSION:-latest}\n container_name: github-collector\n volumes:\n - ./certs:/devo-collector/certs\n - ./config:/devo-collector/config\n - ./credentials:/devo-collector/credentials\n - ./state:/devo-collector/state\n environment:\n - CONFIG_FILE=${CONFIG_FILE:-config.yaml}","type":"text"}]},{"type":"paragraph","content":[{"text":"To run the container using docker-compose, execute the following command from the ","type":"text"},{"text":"/devo-collectors/github/","type":"text","marks":[{"type":"code"}]},{"text":" directory:","type":"text"}]},{"type":"codeBlock","content":[{"text":"IMAGE_VERSION= docker-compose up -d","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":" Replace \"","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":"\" with a proper value.","type":"text"}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported