0ct0pu5
/
tutorials


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
							    <!DOCTYPE html>
    <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
      <head>
        <title>Create and Apply SSL Certificates for Portainer</title>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
        <meta charset="UTF-8">
        <meta name="keywords" content="Browser Based,Docker Made Easy,Home Lab,Home Lab Ideas,Self-Hosted,Web Based,Web Based Tools,Containerization,Docker,Docker Management,Homelab,Portainer,SSL,PKI,Linux,Homelab Ideas,HTTPS,Certificates,Apply SSL Certificates To Portainer,HTTPS Portainer Web Interface,XCI,Private Key Infrastructure,How To,Tutorial,i12bretro">
        <meta name="author" content="i12bretro">
        <meta name="description" content="Create and Apply SSL Certificates for Portainer">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <meta name="revised" content="05/21/2023 07:18:57 AM" />
				          <link rel="icon" type="image/x-icon" href="includes/favicon.ico">
				  <script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js"></script>
				        <script type="text/javascript" src="includes/js/steps.js"></script>
        <link href="css/steps.css" rel="stylesheet" type="text/css" />
      </head>
      <body>
        <div id="gridContainer">
          <div class="topMargin"></div>
          <div id="listName" class="topMargin">
            <h1>Create and Apply SSL Certificates for Portainer</h1>
          </div>
          <div></div>
          <div id="content">
          <h2>Prerequisites</h2>

<ul>
	<li class="noCheckbox">A XCA PKI database <a href="https://youtu.be/ezzj3x207lQ" target="_blank">https://youtu.be/ezzj3x207lQ</a></li>
</ul>

<h2>Create Your SSL Certificate</h2>

<ol>
	<li>Launch XCA</li>
	<li>Open the PKI database if it is not already (File &gt; Open DataBase), enter password</li>
	<li>Click on the Certificates tab, right click on your Intermediate CA certificate</li>
	<li>Select New</li>
	<li>On the Source tab, make sure Use this Certificate for signing is selected</li>
	<li>Verify your Intermediate CA certificate is selected from the drop down</li>
	<li>Click the Subject tab</li>
	<li>Complete the Distinguished Name section
	<p>internalName: ctr.i12bretro.local<br />
	countryName: US<br />
	stateOrProvinceName: Virginia<br />
	localityName: Northern<br />
	organizationName: i12bretro<br />
	organizationUnitName: i12bretro Certificate Authority<br />
	commonName: ctr.i12bretro.local</p>
	</li>
	<li>Click the Generate a New Key button</li>
	<li>Enter a name and set the key size to at least 2048</li>
	<li>Click Create</li>
	<li>Click on the Extensions tab</li>
	<li>Select End Entity from the type list</li>
	<li>Click Edit next to Subject Alternative Name</li>
	<li>Add any DNS or IP addresses that the certificate will identify</li>
	<li>Update the validity dates to fit your needs</li>
	<li>Click the Key Usage tab</li>
	<li>Under Key Usage select Digital Signature, Key Encipherment</li>
	<li>Under Extended Key Usage select Web Server and Web Client Authentication</li>
	<li>Click the Netscape tab</li>
	<li>Select SSL Server</li>
	<li>Click OK to create the certificate</li>
</ol>

<h2>Exporting Required Files</h2>

<ol>
	<li>In XCA, click on the Certificates tab</li>
	<li>Right click the SSL certificate &gt; Export &gt; File</li>
	<li>Set the file name to ssl.crt verify the export format is PEM (*.crt)</li>
	<li>Click OK</li>
	<li>Click the Private Keys tab</li>
	<li>Right click the private key generated for the SSL certificate &gt; Export &gt; File</li>
	<li>Set the file name to ssl.key and verify the export format is PEM Private (*.pem)</li>
	<li>Click OK</li>
</ol>

<h2>Method 1: Applying SSL Certificates to Portainer Web UI</h2>

<ol>
	<li>If the Portainer container wasn&#39;t setup to listen on 9443, connect to the Docker host and run the following commands
	<div class="codeBlock"># list running containers to find the name of the portainer container<br />
	docker ps<br />
	# stop the running portainer container<br />
	docker stop portainer<br />
	# remove the running portainer container<br />
	docker rm portainer --force<br />
	# recreate the portainer container with port 9443<br />
	# modify as needed<br />
	docker run -d -p 8000:8000 -p 9000:9000 -p 9443:9443 --name=portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v ~/docker/portainer:/data portainer/portainer-ce</div>
	</li>
	<li>Open a web browser and navigate to http://DNSorIP:9000</li>
	<li>Log into Portainer</li>
	<li>Click Settings in the left navigation</li>
	<li>Scroll to the SSL certificate section</li>
	<li>Click Select file under Upload X.509 certificate &gt; Browse to and select the ssl.crt file created earlier</li>
	<li>Click Select file under Upload a private key &gt; Browse to and select the ssl.key file created earlier</li>
	<li>Click the Apply Changes button</li>
	<li>Update the browser URL to https://DNSorIP:9443</li>
	<li>Welcome to Portainer running via SSL</li>
</ol>

<h2>Method 2: Applying SSL Certificates to Portainer CLI</h2>

<ol>
	<li>Download WinSCP <a href="https://winscp.net/eng/downloads.php" target="_blank">Download</a></li>
	<li>Extract WinSCP and run the executable</li>
	<li>Connect to the Portainer host IP address via WinSCP</li>
	<li>Copy the exported .pem files to the Portainer host</li>
	<li>Connect to the Docker host and run the following commands
	<div class="codeBlock"># list running containers to find the name of the portainer container<br />
	docker ps<br />
	# stop the running portainer container<br />
	docker stop portainer<br />
	# remove the running portainer container<br />
	docker rm portainer --force<br />
	# recreate the portainer container with ssl enabled<br />
	# modify as needed<br />
	docker run -d -p 8000:8000 -p 9000:9000 -p 9443:9443 --name=portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v ~/docker/portainer:/data portainer/portainer-ce --ssl --sslcert /data/ssl.crt --sslkey /data/ssl.key</div>
	</li>
	<li>Open a web browser and navigate to https://DNSorIP:9443</li>
	<li>Welcome to Portainer running via SSL</li>
</ol>

<p>Further Reading: <a href="https://documentation.portainer.io/v2.0/deploy/ssl/" target="_blank">https://documentation.portainer.io/v2.0/deploy/ssl/</a></p>          </div>
        </div>
      </body>
    </html>