Helix SwarmHelix Swarm

configuration.html

  • //
  • guest/
  • tjuricek/
  • p4oauth/
  • docs/
  • site/
  • configuration.html #2
  • View
  • Commits
  • Open Download .zip Download (5 KB) 
  1. <!DOCTYPE html>
  2. <html lang="en">
  3.   <head>
  4.     <meta charset="utf-8"/>
  5.     <title>Configuration</title>
  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     <meta name="description" content="">
  8.     <meta name="author" content="">
  9.     <meta name="keywords" content="">
  10.     <meta name="generator" content"JBake">
  11.  
  12.     <!-- Le styles -->
  13.     <link href="css/bootstrap.min.css" rel="stylesheet">
  14.     <link href="css/asciidoctor.css" rel="stylesheet">
  15.     <link href="css/base.css" rel="stylesheet">
  16.  
  17.     <!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
  18.     <!--[if lt IE 9]>
  19.       <script src="js/html5shiv.js"></script>
  20.     <![endif]-->
  21.  
  22.     <!-- Fav and touch icons -->
  23.     <!--<link rel="apple-touch-icon-precomposed" sizes="144x144" href="../assets/ico/apple-touch-icon-144-precomposed.png">
  24.     <link rel="apple-touch-icon-precomposed" sizes="114x114" href="../assets/ico/apple-touch-icon-114-precomposed.png">
  25.     <link rel="apple-touch-icon-precomposed" sizes="72x72" href="../assets/ico/apple-touch-icon-72-precomposed.png">
  26.     <link rel="apple-touch-icon-precomposed" href="../assets/ico/apple-touch-icon-57-precomposed.png">-->
  27.     <link rel="shortcut icon" href="favicon.ico">
  28.   </head>
  29.   <body>
  30.     <div id="wrap">
  31.  
  32. <nav class="navbar navbar-default" role="navigation">
  33.     <div class="container-fluid">
  34.         <div class="navbar-header">
  35.             <ul class="nav navbar-nav">
  36.                 <li><a href=".">p4oauth</a></li>
  37.                 <li><a href="overview.html">Overview</a></li>
  38.                 <li><a href="configuration.html">Configuration</a></li>
  39.                 <li><a href="api.html">API</a></li>
  40.                 <li><a href="development.html">Development</a></li>
  41.                 <li><a href="../javadoc">Javadoc</a></li>
  42.             </ul>
  43.         </div>
  44.     </div>
  45. </nav>
  46.  
  47. <div class="container">
  48.  
  49. <h1>Configuring and Running P4OAuth</h1><p>The current setup of P4OAuth is fairly manual:</p>
  50. <ol>
  51.   <li><p>Download the latest version here: <a href='https://bintray.com/tristanjuricek/maven/p4oauth/_latestVersion'><img src='https://api.bintray.com/packages/tristanjuricek/maven/p4oauth/images/download.png'></a></p>
  52.   <ul>
  53.     <li>Open the files tab</li>
  54.     <li>Download the <code>p4oauth-VERSION.jar</code> file</li>
  55.   </ul></li>
  56.   <li><p>Put the binary in a "working folder"</p></li>
  57.   <li><p>Prepare a Java keystore file (see below for a self-signed mechanism)</p></li>
  58.   <li><p>Create a <code>P4OAuth.yml</code> configuration file (see below)</p></li>
  59.   <li><p>Create a <code>whitelist</code> configuration file (see below)</p></li>
  60.   <li><p>Launch P4OAuth: <code>java -jar p4oauth.jar P4OAuth.yml</code></p></li>
  61. </ol><h2>Create A self-signed Java keystore file</h2><p>Here's an example of using the <code>keytool</code> command that we currently use to prepare environments automatically:</p>
  62. <pre><code>keytool -genkeypair -dname &quot;cn=Developer, ou=Engineering, o=Perforce, c=US&quot; \
  63.     -alias business -keypass password -keystore keystore -storepass password \
  64.     -validity 180
  65. </code></pre><p>It's run in the working directly, and sets up a simple keystore with the key<br/>and store passwords set to <code>password</code>.</p><p>For more information on <code>keytool</code> please see the <a href="http://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html">official documentation from Oracle</a>.</p><h2>Create a P4OAuth.yml file</h2><p>Here's an example P4OAuth.yml file used for testing:</p>
  66. <pre><code>!com.perforce.workshop.tjuricek.p4oauth.config.P4OAuthConfig
  67. keyStorePath:         /Users/tjuricek/dev/workshop/p4oauth/functional_tests/build/keystore
  68. keyStorePassword:     password
  69. keyManagerPassword:   password
  70. hostname:             dhcp-141-n100.dhcp.perforce.com
  71. rootDirectory:        /Users/tjuricek/dev/workshop/p4oauth/functional_tests/build/p4oauth
  72.  
  73. perforce: !com.perforce.workshop.tjuricek.p4oauth.config.PerforceConfig
  74.     hostname: 127.0.0.1
  75.     port: 1666
  76. </code></pre><p>Please note that this is mapped pretty directly to the Java class <a href="../javadoc/com/perforce/workshop/tjuricek/p4oauth/config/P4OAuthConfig.html"><code>P4OAuthConfig</code></a>. Please refer to the javaDoc for more details.</p><h2>Create the whitelist configuration file</h2><p>Here's another example file used for testing:</p>
  77. <pre><code>servers:
  78.   - !com.perforce.workshop.tjuricek.p4oauth.models.WhitelistedServer
  79.     name: test_server
  80.     redirectUri: https://dhcp-141-n100.dhcp.perforce.com:8444/handle
  81.     ipAddress: 127.0.0.1
  82. </code></pre><p>Please note this is also mapped to a single Java class <a href="../javadoc/com/perforce/workshop/tjuricek/p4oauth/models/Whitelist.html"><code>Whitelist</code></a>. Please refer to the javadoc for more details.</p>
  83.  
  84. </div>
  85.  
  86.     </div><!-- #wrap -->
  87.  
  88.     
  89.     <!-- Le javascript
  90.     ================================================== -->
  91.     <!-- Placed at the end of the document so the pages load faster -->
  92.     <script src="js/jquery-1.11.1.min.js"></script>
  93.     <script src="js/bootstrap.min.js"></script>
  94.  
  95.   </body>
  96. </html>
# Change User Description Committed
#2 9181 tjuricek Updating documentation 11 years ago
#1 9161 tjuricek 0.1.0 Minimal p4oauth server that provides a basic authorization code grant. 11 years ago