-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
303 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,253 @@ | ||
| <!DOCTYPE HTML> | ||
| <html lang="en" class="light" dir="ltr"> | ||
| <head> | ||
| <!-- Book generated using mdBook --> | ||
| <meta charset="UTF-8"> | ||
| <title>Clients - Documentation</title> | ||
|
|
||
|
|
||
| <!-- Custom HTML head --> | ||
|
|
||
| <meta name="description" content=""> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <meta name="theme-color" content="#ffffff"> | ||
|
|
||
| <link rel="icon" href="favicon.svg"> | ||
| <link rel="shortcut icon" href="favicon.png"> | ||
| <link rel="stylesheet" href="css/variables.css"> | ||
| <link rel="stylesheet" href="css/general.css"> | ||
| <link rel="stylesheet" href="css/chrome.css"> | ||
| <link rel="stylesheet" href="css/print.css" media="print"> | ||
|
|
||
| <!-- Fonts --> | ||
| <link rel="stylesheet" href="FontAwesome/css/font-awesome.css"> | ||
| <link rel="stylesheet" href="fonts/fonts.css"> | ||
|
|
||
| <!-- Highlight.js Stylesheets --> | ||
| <link rel="stylesheet" href="highlight.css"> | ||
| <link rel="stylesheet" href="tomorrow-night.css"> | ||
| <link rel="stylesheet" href="ayu-highlight.css"> | ||
|
|
||
| <!-- Custom theme stylesheets --> | ||
|
|
||
| </head> | ||
| <body class="sidebar-visible no-js"> | ||
| <div id="body-container"> | ||
| <!-- Provide site root to javascript --> | ||
| <script> | ||
| var path_to_root = ""; | ||
| var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light"; | ||
| </script> | ||
|
|
||
| <!-- Work around some values being stored in localStorage wrapped in quotes --> | ||
| <script> | ||
| try { | ||
| var theme = localStorage.getItem('mdbook-theme'); | ||
| var sidebar = localStorage.getItem('mdbook-sidebar'); | ||
|
|
||
| if (theme.startsWith('"') && theme.endsWith('"')) { | ||
| localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); | ||
| } | ||
|
|
||
| if (sidebar.startsWith('"') && sidebar.endsWith('"')) { | ||
| localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); | ||
| } | ||
| } catch (e) { } | ||
| </script> | ||
|
|
||
| <!-- Set the theme before any content is loaded, prevents flash --> | ||
| <script> | ||
| var theme; | ||
| try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } | ||
| if (theme === null || theme === undefined) { theme = default_theme; } | ||
| var html = document.querySelector('html'); | ||
| html.classList.remove('light') | ||
| html.classList.add(theme); | ||
| var body = document.querySelector('body'); | ||
| body.classList.remove('no-js') | ||
| body.classList.add('js'); | ||
| </script> | ||
|
|
||
| <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> | ||
|
|
||
| <!-- Hide / unhide sidebar before it is displayed --> | ||
| <script> | ||
| var body = document.querySelector('body'); | ||
| var sidebar = null; | ||
| var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); | ||
| if (document.body.clientWidth >= 1080) { | ||
| try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } | ||
| sidebar = sidebar || 'visible'; | ||
| } else { | ||
| sidebar = 'hidden'; | ||
| } | ||
| sidebar_toggle.checked = sidebar === 'visible'; | ||
| body.classList.remove('sidebar-visible'); | ||
| body.classList.add("sidebar-" + sidebar); | ||
| </script> | ||
|
|
||
| <nav id="sidebar" class="sidebar" aria-label="Table of contents"> | ||
| <div class="sidebar-scrollbox"> | ||
| <ol class="chapter"><li class="chapter-item expanded "><a href="configuration.html"><strong aria-hidden="true">1.</strong> Configuration</a></li><li class="chapter-item expanded "><a href="clients.html" class="active"><strong aria-hidden="true">2.</strong> Clients</a></li><li class="chapter-item expanded "><div><strong aria-hidden="true">3.</strong> Use</div></li><li class="chapter-item expanded "><div><strong aria-hidden="true">4.</strong> Developing</div></li></ol> | ||
| </div> | ||
| <div id="sidebar-resize-handle" class="sidebar-resize-handle"> | ||
| <div class="sidebar-resize-indicator"></div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <!-- Track and set sidebar scroll position --> | ||
| <script> | ||
| var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); | ||
| sidebarScrollbox.addEventListener('click', function(e) { | ||
| if (e.target.tagName === 'A') { | ||
| sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); | ||
| } | ||
| }, { passive: true }); | ||
| var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); | ||
| sessionStorage.removeItem('sidebar-scroll'); | ||
| if (sidebarScrollTop) { | ||
| // preserve sidebar scroll position when navigating via links within sidebar | ||
| sidebarScrollbox.scrollTop = sidebarScrollTop; | ||
| } else { | ||
| // scroll sidebar to current active section when navigating via "next/previous chapter" buttons | ||
| var activeSection = document.querySelector('#sidebar .active'); | ||
| if (activeSection) { | ||
| activeSection.scrollIntoView({ block: 'center' }); | ||
| } | ||
| } | ||
| </script> | ||
|
|
||
| <div id="page-wrapper" class="page-wrapper"> | ||
|
|
||
| <div class="page"> | ||
| <div id="menu-bar-hover-placeholder"></div> | ||
| <div id="menu-bar" class="menu-bar sticky"> | ||
| <div class="left-buttons"> | ||
| <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> | ||
| <i class="fa fa-bars"></i> | ||
| </label> | ||
| <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> | ||
| <i class="fa fa-paint-brush"></i> | ||
| </button> | ||
| <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> | ||
| <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li> | ||
| <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> | ||
| <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> | ||
| <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> | ||
| <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> | ||
| </ul> | ||
| <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar"> | ||
| <i class="fa fa-search"></i> | ||
| </button> | ||
| </div> | ||
|
|
||
| <h1 class="menu-title">Documentation</h1> | ||
|
|
||
| <div class="right-buttons"> | ||
| <a href="print.html" title="Print this book" aria-label="Print this book"> | ||
| <i id="print-button" class="fa fa-print"></i> | ||
| </a> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| <div id="search-wrapper" class="hidden"> | ||
| <form id="searchbar-outer" class="searchbar-outer"> | ||
| <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> | ||
| </form> | ||
| <div id="searchresults-outer" class="searchresults-outer hidden"> | ||
| <div id="searchresults-header" class="searchresults-header"></div> | ||
| <ul id="searchresults"> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> | ||
| <script> | ||
| document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); | ||
| document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); | ||
| Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { | ||
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); | ||
| }); | ||
| </script> | ||
|
|
||
| <div id="content" class="content"> | ||
| <main> | ||
| <h1 id="clients"><a class="header" href="#clients">Clients</a></h1> | ||
| <h2 id="java-edc-extension"><a class="header" href="#java-edc-extension">Java EDC Extension</a></h2> | ||
| <h3 id="integrating-with-maven-repository"><a class="header" href="#integrating-with-maven-repository">Integrating with Maven Repository</a></h3> | ||
| <p>To use the Maven package from our repository, update your <code>build.gradle.kts</code> with the following repository configuration:</p> | ||
| <pre><code class="language-kotlin">repositories { | ||
| mavenCentral() | ||
| maven { | ||
| url = uri("https://maven.pkg.github.com/truzzt/mds-ap3") | ||
| credentials { | ||
| username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") | ||
| password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") | ||
| } | ||
| } | ||
| } | ||
| </code></pre> | ||
| <p>This configuration includes the necessary Maven repository for our package and sets up authentication using either project properties or environment variables.</p> | ||
| <h3 id="setting-up-authentication"><a class="header" href="#setting-up-authentication">Setting Up Authentication</a></h3> | ||
| <p>To access our public Maven repository, authentication is required. Please follow the detailed <a href="https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages">GitHub Packages with Apache Maven documentation</a> for guidance on setting up authentication.</p> | ||
| <h3 id="adding-the-dependency"><a class="header" href="#adding-the-dependency">Adding the Dependency</a></h3> | ||
| <p>Once the repository is added and authentication is configured, you can include the package in your dependencies:</p> | ||
| <pre><code class="language-kotlin">dependencies { | ||
| implementation("logging-house:logging-house-client:0.1.0") | ||
| } | ||
| </code></pre> | ||
| <h3 id="environment-configuration"><a class="header" href="#environment-configuration">Environment Configuration</a></h3> | ||
| <p>The <code>logging-house-client</code> relies on two key environment variables for configuration:</p> | ||
| <div class="table-wrapper"><table><thead><tr><th>Name</th><th>Default</th><th>Description</th></tr></thead><tbody> | ||
| <tr><td><code>CLEARINGHOUSE_CLIENT_EXTENSION_ENABLED</code></td><td><code>false</code></td><td>Set to <code>true</code> to enable the extension, or <code>false</code> to disable it.</td></tr> | ||
| <tr><td><code>EDC_CLEARINGHOUSE_LOG_URL</code></td><td><code>none</code></td><td>Specify the URL of the Logging-House-Server (e.g., <code>clearing.demo.truzzt.eu</code>).</td></tr> | ||
| </tbody></table> | ||
| </div> | ||
| <p>Ensure these environment variables are set as per your requirements for optimal functionality of the client.</p> | ||
|
|
||
| </main> | ||
|
|
||
| <nav class="nav-wrapper" aria-label="Page navigation"> | ||
| <!-- Mobile navigation buttons --> | ||
| <a rel="prev" href="configuration.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | ||
| <i class="fa fa-angle-left"></i> | ||
| </a> | ||
|
|
||
|
|
||
| <div style="clear: both"></div> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
|
|
||
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> | ||
| <a rel="prev" href="configuration.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | ||
| <i class="fa fa-angle-left"></i> | ||
| </a> | ||
|
|
||
| </nav> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <script> | ||
| window.playground_copyable = true; | ||
| </script> | ||
|
|
||
|
|
||
| <script src="elasticlunr.min.js"></script> | ||
| <script src="mark.min.js"></script> | ||
| <script src="searcher.js"></script> | ||
|
|
||
| <script src="clipboard.min.js"></script> | ||
| <script src="highlight.js"></script> | ||
| <script src="book.js"></script> | ||
|
|
||
| <!-- Custom JS scripts --> | ||
|
|
||
|
|
||
| </div> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.