GitHub Integration Guide - HL Vanilla Community
<main> <article class="userContent"> <p>You can integrate your <strong>Higher Logic Vanilla</strong> (<strong>Vanilla</strong>) community with GitHub so that you can easily <em>create an Issue in GitHub</em> directly from a Vanilla community comment or discussion.</p><h3 data-id="what-is-github">What is GitHub?</h3><p><a href="http://github.com/" rel="nofollow noreferrer ugc">GitHub</a> is a code repository that developers use to store source code. Developers can contribute code to a common source code and changes are tracked using distributed version control.</p><h2 data-id="set-up-steps">Set-up steps</h2><p><strong>FIRST</strong>: Enable the GitHub addon in your Vanilla community.</p><p>1. Access the Dashboard.</p><p>2. Navigate to <strong>Settings > Addons > Addons</strong>.</p><p>3. On the Vanilla Addons page, locate the <strong>GitHub</strong> addon and slide the toggle to the right (ON) to enable it.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/ZOQE3EFG8BAJ/addon.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/ZOQE3EFG8BAJ/addon.png" alt="Addon.png" height="356" width="792" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>4. Click the <strong>settings</strong> icon, specify the <em>ClientID</em>, <em>Secret</em>, <em>Repositories</em>, and <em>Global Login</em>, and then click <strong>Save</strong>.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/21VQNBRPJ0DI/settings.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/21VQNBRPJ0DI/settings.png" alt="Settings.png" height="608" width="1012" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p><strong>SECOND</strong>: Follow the steps in the <a href="https://images.v-cdn.net/vfcom/docs/GitHub-Vanilla-Integration-Guide.pdf" rel="nofollow noreferrer ugc"><em>GitHub and Vanilla Forums Integration Guide</em></a>.</p><h2 data-id="how-to-create-an-issue">How to create an Issue</h2><p>Authorized (Staff) users can:</p><ol><li>Click the <strong>gear</strong> icon in discussions and comments.</li><li>Select <strong>GitHub - Create Issue</strong>.</li></ol><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://blog.vanillaforums.com/hs-fs/hubfs/Imported_Blog_Media/GitHub-Vanilla-Integration-Guide_1a-5.png?width=195&height=240&name=GitHub-Vanilla-Integration-Guide_1a-5.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://blog.vanillaforums.com/hs-fs/hubfs/Imported_Blog_Media/GitHub-Vanilla-Integration-Guide_1a-5.png?width=195&height=240&name=GitHub-Vanilla-Integration-Guide_1a-5.png" alt="GitHub-Vanilla-Integration-Guide" height="180" width="320" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>📝 <strong>NOTE</strong>: The <strong>Name</strong> and <strong>Email</strong> fields will be populated; other required fields must be completed.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://blog.vanillaforums.com/hs-fs/hubfs/Imported_Blog_Media/GitHub-Vanilla-Integration-Guide_2a-6.png?width=542&height=358&name=GitHub-Vanilla-Integration-Guide_2a-6.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://blog.vanillaforums.com/hs-fs/hubfs/Imported_Blog_Media/GitHub-Vanilla-Integration-Guide_2a-6.png?width=542&height=358&name=GitHub-Vanilla-Integration-Guide_2a-6.png" alt="GitHub-Vanilla-Integration-Guide_2a" height="180" width="320" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>The Issue is created in GitHub and:</p><ul><li>an information panel displays (to Staff only) under the discussion or comment</li></ul><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/M4CKN88G4DXT/image.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/M4CKN88G4DXT/image.png" alt="image.png" height="88" width="503" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <ul><li>the Issue displays in GitHub</li></ul><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://blog.vanillaforums.com/hs-fs/hubfs/Imported_Blog_Media/GitHub-Vanilla-Integration-Guide_41-7.png?width=557&height=282&name=GitHub-Vanilla-Integration-Guide_41-7.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://blog.vanillaforums.com/hs-fs/hubfs/Imported_Blog_Media/GitHub-Vanilla-Integration-Guide_41-7.png?width=557&height=282&name=GitHub-Vanilla-Integration-Guide_41-7.png" alt="GitHub-Vanilla-Integration-Guide_4" height="180" width="320" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>📝 <strong>NOTE</strong>: The integration works best when using the markdown editor. Also, our GitHub integration uses oAuth, so your GitHub passwords are never stored in Vanilla.</p><h2 data-id="set-up-instructions">Set-up instructions</h2><p>If you already have a GitHub account, you must enable API Access in order for this integration to work.</p><p><a href="https://github.com/settings/applications/new" rel="nofollow noreferrer ugc">Create a new application in GitHub</a> and set the <strong>callback URL</strong> by appending <strong>/profile/githubconnect</strong> to your forum’s URL. For example:</p><ul><li>If a forum URL is <strong>example.com/forum</strong>, the callback URL is <strong>http://example.com/forum/profile/githubconnect</strong>.</li></ul><p>After your new application is set up, open:</p><p><strong>A</strong>) the GitHub addon settings dialog (step 4 of <em>Set Up Steps</em>, above) and</p><p><strong>B</strong>) your GitHub plugin settings page.</p><ul><li>Copy the values of <em>ClientID</em>, <em>Secret</em>, and <em>Repositories</em> from <strong>A</strong> and paste them where appropriate on <strong>B</strong>.</li></ul> </article> </main>