Change the project name to HTTPS-PORTAL

0x1b2c · 0x1b2c · commit ab7b1d8497cb · 2016-01-03T19:42:12.000+08:00
diff --git a/Dockerfile b/Dockerfile
@@ -25,6 +25,6 @@ COPY ./fs_overlay /
 RUN chmod a+x /bin/* && \
     chmod a+x /etc/cron.weekly/renew_certs
 
-VOLUME /var/lib/nginx-acme
+VOLUME /var/lib/https-portal
 
 ENTRYPOINT ["/init"]
diff --git a/README.md b/README.md
@@ -1,30 +1,29 @@
-# Nginx-ACME
+# HTTPS-PORTAL
 
-Nginx-ACME is a fully automated HTTPS server powered by
+HTTPS-PORTAL is a fully automated HTTPS server powered by
 [Nginx](http://nginx.org), [Let's Encrypt](https://letsencrypt.org) and
-
 [Docker](https://www.docker.com). By using it, you can run any existing web
 application over HTTPS, with only one extra line of configuration.
 
 The SSL certificates are obtain, and renew from Let's Encrypt automatically.
 
 Docker Hub page:
-[https://hub.docker.com/r/steveltn/nginx-acme/](https://hub.docker.com/r/steveltn/nginx-acme/)
+[https://hub.docker.com/r/steveltn/https-portal/](https://hub.docker.com/r/steveltn/https-portal/)
 
 ## Warning
 
 This project is in active development stage. Use it in production with CAUTION.
 
 ## Quick Start
 
-Nginx-ACME shipped as a Docker image, so before use it, you need a Linux
+HTTPS-PORTAL shipped as a Docker image, so before use it, you need a Linux
 machine (either local or remote host) with Docker installed. We recommand use
 [Docker Compose](https://docs.docker.com/compose/) to run it. Create a
 `docker-compose.yml` file with the following content in any directory:
 
 ```yaml
-nginx-acme:
-  image: steveltn/nginx-acme
+https-portal:
+  image: steveltn/https-portal
   ports:
     - 80:80
     - 443:443
@@ -51,8 +50,8 @@ Then run `docker-compose up` command in the same directory, moment later
 you'll get a WordPress running on
 [https://wordpress.example.com](https://wordpress.example.com).
 
-In the above example, only environment variables under `nginx-acme` section
-are Nginx-ACME specific configurations.
+In the above example, only environment variables under `https-portal` section
+are HTTPS-PORTAL specific configurations.
 
 Note: `PRODUCTION` flag is `false` by default, which results in a test
 (untrusted) certificate from Let's Encrypt.
@@ -63,8 +62,8 @@ In case you simply want to quickly get a running HTTPS server, you can use the
 following `docker-compose.yml` file:
 
 ```yaml
-nginx-acme:
-  image: steveltn/nginx-acme
+https-portal:
+  image: steveltn/https-portal
   ports:
     - 80:80
     - 443:443
@@ -87,7 +86,7 @@ Then run `docker-compose up`, now you'll have a welcome page running in
 You can specify multiple domains by splitting them with comma:
 
 ```yaml
-nginx-acme:
+https-portal:
   # ...
   environment:
     DOMAINS: 'wordpress.example.com -> http://wordpress, gitlab.example.com
@@ -96,14 +95,14 @@ nginx-acme:
 
 ### Share Certificates with Other Apps
 
-You can mount an arbitrary host directory to `/var/lib/nginx-acme` as a
+You can mount an arbitrary host directory to `/var/lib/https-portal` as a
 [data volume](https://docs.docker.com/engine/userguide/dockervolumes/).
 
 ```yaml
-nginx-acme:
+https-portal:
   # ...
   volumes:
-    - /data/ssl_certs:/var/lib/nginx-acme
+    - /data/ssl_certs:/var/lib/https-portal
 ```
 
 Now your certificates are available in `/data/ssl_certs` of your Docker host.
@@ -136,9 +135,9 @@ the rate limit is
 The former is not usually a problem, however the latter could be if you want
 to use multiple sub-domains on a single domain. Let's Encrypt does support SAN
 certificates, however it requires careful planning and is hard to automate. So
-in Nginx-ACME we only deal with CN certificates.
+in HTTPS-PORTAL we only deal with CN certificates.
 
-Nginx-ACME stores your certificates in a data volume and will not re-sign
+HTTPS-PORTAL stores your certificates in a data volume and will not re-sign
 certificates until 30 days before expiration if one exists (you can force
 renew certificates by using `FORCE_RENEW: 'true'` environment variable).
 However if you play around with the image a lot, you can hit the limit. That's
diff --git a/examples/custom_config/Dockerfile b/examples/custom_config/Dockerfile
@@ -1,3 +1,3 @@
-FROM steveltn/nginx-acme
+FROM steveltn/https-portal
 
 ADD ./nginx-conf/ /var/lib/nginx-conf
diff --git a/examples/custom_config/docker-compose.yml b/examples/custom_config/docker-compose.yml
@@ -1,4 +1,4 @@
-nginx-acme:
+https-portal:
   build: ./
   ports:
     - 80:80
diff --git a/examples/minimal/docker-compose.yml b/examples/minimal/docker-compose.yml
@@ -1,5 +1,5 @@
-nginx-acme:
-  image: steveltn/nginx-acme
+https-portal:
+  image: steveltn/https-portal
   # You can build from source code rather than use the prebuilt image from Docker Hub.
   # build: ../..
   ports:
diff --git a/examples/wordpress/docker-compose.yml b/examples/wordpress/docker-compose.yml
@@ -1,13 +1,13 @@
-nginx-acme:
-  image: steveltn/nginx-acme
+https-portal:
+  image: steveltn/https-portal
   # You can build from source code rather than use the prebuilt image from Docker Hub.
   # build: ../..
   ports:
     - 80:80
     - 443:443
   links:
     - wordpress
-  # Restart nginx-acme on failure or after Docker host restart.
+  # Restart https-portal on failure or after Docker host restart.
   restart: always
   environment:
     # Forward wordpress.example.com to the WordPress container.
diff --git a/fs_overlay/opt/certs_manager/certs_manager.rb b/fs_overlay/opt/certs_manager/certs_manager.rb
@@ -76,7 +76,7 @@ def ensure_signed(domains)
   end
 
   def obtain_lock
-    self.lock = File.open("/tmp/nginx-acme.lock", File::CREAT)
+    self.lock = File.open("/tmp/https-portal.lock", File::CREAT)
 
     lock.flock File::LOCK_EX
   end
diff --git a/fs_overlay/opt/certs_manager/lib/acme.rb b/fs_overlay/opt/certs_manager/lib/acme.rb
@@ -4,7 +4,7 @@ def self.sign(domain)
 
     command = <<-EOC
       acme_tiny \
-        --account-key /var/lib/nginx-acme/account.key \
+        --account-key /var/lib/https-portal/account.key \
         --csr #{domain.csr_path} \
         --acme-dir /var/www/challenges/ \
         --ca #{NAConfig.ca} > #{domain.signed_cert_path}
diff --git a/fs_overlay/opt/certs_manager/lib/commands.rb b/fs_overlay/opt/certs_manager/lib/commands.rb
@@ -2,15 +2,15 @@
 
 module Commands
   def download_intermediate_cert
-    File.open('/var/lib/nginx-acme/intermediate.pem', 'wb') do |saved_file|
+    File.open('/var/lib/https-portal/intermediate.pem', 'wb') do |saved_file|
       open('https://letsencrypt.org/certs/lets-encrypt-x1-cross-signed.pem', "rb") do |read_file|
         saved_file.write(read_file.read)
       end
     end
   end
 
   def chain_keys(domain)
-    system "cat #{domain.signed_cert_path} /var/lib/nginx-acme/intermediate.pem > #{domain.chained_cert_path}"
+    system "cat #{domain.signed_cert_path} /var/lib/https-portal/intermediate.pem > #{domain.chained_cert_path}"
   end
 
   def mkdir(domain)
diff --git a/fs_overlay/opt/certs_manager/lib/na_config.rb b/fs_overlay/opt/certs_manager/lib/na_config.rb
@@ -20,7 +20,7 @@ def self.force_renew?
   end
 
   def self.dhparam_path
-    "/var/lib/nginx-acme/dhparam.pem"
+    "/var/lib/https-portal/dhparam.pem"
   end
 
   def self.env_domains
diff --git a/fs_overlay/opt/certs_manager/lib/open_ssl.rb b/fs_overlay/opt/certs_manager/lib/open_ssl.rb
@@ -2,8 +2,8 @@
 
 module OpenSSL
   def self.ensure_account_key
-    unless File.exist? "/var/lib/nginx-acme/account.key"
-      system 'openssl genrsa 4096 > /var/lib/nginx-acme/account.key'
+    unless File.exist? "/var/lib/https-portal/account.key"
+      system 'openssl genrsa 4096 > /var/lib/https-portal/account.key'
     end
   end
 
diff --git a/fs_overlay/opt/certs_manager/models/domain.rb b/fs_overlay/opt/certs_manager/models/domain.rb
@@ -25,9 +25,9 @@ def key_path
 
   def dir
     if NAConfig.production?
-      "/var/lib/nginx-acme/#{name}"
+      "/var/lib/https-portal/#{name}"
     else
-      "/var/lib/nginx-acme/#{name}-staging/"
+      "/var/lib/https-portal/#{name}-staging/"
     end
   end
 end
diff --git a/fs_overlay/var/www/index.html b/fs_overlay/var/www/index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-<title>Welcome to Nginx-ACME!</title>
+<title>Welcome to HTTPS-PORTAL!</title>
 <style>
     body {
         width: 35em;
@@ -11,19 +11,19 @@
 </style>
 </head>
 <body>
-<h1>Welcome to Nginx-ACME!</h1>
+<h1>Welcome to HTTPS-PORTAL!</h1>
 <p>
   Your site is avaible in HTTPS with certificate issued by
   <a href="https://letsencrypt.org">Let's Encrypt</a>.
 </p>
 <p>
-  If you did not turn on "PRODUCTION" flag in Nginx-ACME config, you are using
+  If you did not turn on "PRODUCTION" flag in HTTPS-PORTAL config, you are using
   a test certificate issued by Let's Encrypt staging server which might not be
   trusted by your browser.
 </p>
 <p>
   Documents are available at
-  <a href="https://github.com/SteveLTN/nginx-acme">https://github.com/SteveLTN/nginx-acme</a>.
+  <a href="https://github.com/SteveLTN/https-portal">https://github.com/SteveLTN/https-portal</a>.
 </p>
 </body>
 </html>
diff --git a/tests/compositions/auto-discovery/docker-compose.yml b/tests/compositions/auto-discovery/docker-compose.yml
@@ -1,4 +1,4 @@
-nginx-acme:
+https-portal:
   build: ../../..
   ports:
     - 80:80
@@ -13,7 +13,7 @@ wordpress:
   links:
     - db:mysql
   environment:
-    VIRTUAL_HOST: test.nginx-acme.site
+    VIRTUAL_HOST: test.https-portal.site
 
 db:
   image: mariadb
diff --git a/tests/compositions/linked-containers/docker-compose.yml b/tests/compositions/linked-containers/docker-compose.yml
@@ -1,12 +1,12 @@
-nginx-acme:
+https-portal:
   build: ../../..
   ports:
     - 80:80
     - 443:443
   links:
     - wordpress
   environment:
-    DOMAINS: test.nginx-acme.site->http://wordpress
+    DOMAINS: test.https-portal.site->http://wordpress
 
 wordpress:
   image: wordpress
diff --git a/tests/compositions/minimal-setup/docker-compose.yml b/tests/compositions/minimal-setup/docker-compose.yml
@@ -1,7 +1,7 @@
-nginx-acme:
+https-portal:
   build: ../../..
   ports:
     - 80:80
     - 443:443
   environment:
-    DOMAINS: test.nginx-acme.site
+    DOMAINS: test.https-portal.site
diff --git a/tests/suites/test_minimal_setup.rb b/tests/suites/test_minimal_setup.rb
@@ -11,13 +11,13 @@ def test_auto_discovery
     `cd ./compositions/minimal-setup/ && docker-compose build && docker-compose up -d`
 
     page = read_https_content
-    assert page.include?("Welcome to Nginx-ACME!")
+    assert page.include?("Welcome to HTTPS-PORTAL!")
 
     # When certificates are stored in a data volume
     `cd ./compositions/minimal-setup/ && docker-compose build && docker-compose up -d`
 
     page = read_https_content
-    assert page.include?("Welcome to Nginx-ACME!")
+    assert page.include?("Welcome to HTTPS-PORTAL!")
   end
 
   def teardown
diff --git a/tests/suites/test_renewal.rb b/tests/suites/test_renewal.rb
@@ -6,7 +6,7 @@ def test_auto_discovery
     `cd ./compositions/minimal-setup/ && docker-compose build && docker-compose up -d`
 
     read_https_content
-    output = `docker exec minimalsetup_nginx-acme_1 bash -c 'test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )'`
+    output = `docker exec minimalsetup_https-portal_1 bash -c 'test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )'`
 
     assert output.include?("No need to renew certs for #{TEST_DOMAIN}")
   end
diff --git a/tests/test_helper.rb b/tests/test_helper.rb
@@ -1,4 +1,4 @@
-TEST_DOMAIN = "test.nginx-acme.site"
+TEST_DOMAIN = "test.https-portal.site"
 
 require "open-uri"
 require "openssl"

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-FROM steveltn/nginx-acme`
	`1`	`+FROM steveltn/https-portal`
`2`	`2`
`3`	`3`	`ADD ./nginx-conf/ /var/lib/nginx-conf`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-nginx-acme:`
	`1`	`+https-portal:`
`2`	`2`	`build: ./`
`3`	`3`	`ports:`
`4`	`4`	`- 80:80`