Skip to content

Commit

Permalink
Fix typos and grammar, add link to github issues to fix broken report…
Browse files Browse the repository at this point in the history
… link in adminUI, bump ruby version to v2.7.5 (#57)

* Fix typos and grammar

Fixed a few misspelled words, and added several "the"s to make the sentences flow better in English, and fixed some other minor grammar.


Note:
i did not fix this sentence yet since I'm not certain what it means exactly but again i think it just needs a "the" somewhere to make it totally clear will update when I've spoken to someone to clarify.
`But please note, for every subdomain certificate is requested since it uses HTTP challenges which cannot be used for issuing wildcard certificates.`

* Add link to github issue

Moved license up like most other dappnode_package.JSONs
and added link to this repo's Issues to fix the broken report link in the adminUI

* changed title of HTTPS logo to "HTTPS" 

Logo for the HTTPS logo was titled as "DAPPMANAGER" so i changed it to "HTTPS"

* Bump Ruby version

Bumped ruby version per @3alpha to allow CI to build successfully

* Fixed last sentence grammar

added an "a" to make the sentence flow properly and make sense
  • Loading branch information
alexpeterson91 authored Dec 7, 2021
1 parent c1c60d1 commit dfaae72
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM ruby:2.7.4-alpine AS ruby-builder
FROM ruby:2.7.5-alpine AS ruby-builder

RUN apk add --update build-base

Expand Down Expand Up @@ -50,7 +50,7 @@ RUN export ARCH=$(echo $TARGETPLATFORM | cut -d'/' -f2 | sed 's/arm64/aarch64/')
rm /etc/nginx/conf.d/default.conf && \
apk add --update \
# From original image
python2 ruby=2.7.4-r0 iproute2 apache2-utils logrotate openssl \
python2 ruby=2.7.5-r0 iproute2 apache2-utils logrotate openssl \
# For Typescript app
nodejs \
&& \
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# HTTPS

This is a fork of a original [https-portal](https://github.com/SteveLTN/https-portal), with additional features intended to use in [DAppNode](https://github.com/dappnode/DAppNode) as one of the core packages. All of its existing features should remain functional.
This is a fork of an original [https-portal](https://github.com/SteveLTN/https-portal), with additional features intended to be used in [DAppNode](https://github.com/dappnode/DAppNode) as one of the core packages. All of its existing features should remain functional.

<p align="center"><a href="#"><img width="150" title="DAPPMANAGER" src='https-portal-avatar.png' /></a></p>
<p align="center"><a href="#"><img width="150" title="HTTPS" src='https-portal-avatar.png' /></a></p>

## Configurable forwarding

API was added through which containers proxied through portal can be dinamically chosen. By default server listens at port `5000` for `GET` methods `add` and `remove` both of which have `to` and `from` querry parameters i.e.
API was added through which containers proxied through portal can be dynamically chosen. By default the server listens at port `5000` for `GET` methods `add` and `remove` both of which have `to` and `from` query parameters i.e.

```
GET /add?from=<chosen-subodomain>&to=<internal-resource>
GET /remove?from=<chosen-subodomain>&to=<internal-resource>
```

Where `chosen-subdomain` is chosen external endpoint for forwarding and `internal-resource` is either IP or domain that resolves on the internal network.
Where `chosen-subdomain` is the chosen external endpoint for forwarding and `internal-resource` is either the IP or domain that resolves on the internal network.

## DAppNode certificates

When using DAppNode dyndns service, https-portal uses DAppNode certificate service to get wildcard certificates for the DAppNode dyndns domains which are provided for free. In this mode, following environment variables have to be set:
When using the DAppNode dyndns service, https-portal uses DAppNode's certificate service to get wildcard certificates for the DAppNode dyndns domains which are provided for free. In this mode, the following environment variables have to be set:
| Name | Value | Description |
| -------------- | --------------------- | ----------------------------- |
| CERTAPI_URL | TBD | URL of remote signing service |
Expand All @@ -26,8 +26,8 @@ This mode can only be used within DAppNode as a package.

## Running DAppNode on your own domain

It is even possible to run DAppNode on your own domain. Your domain and all of its subdomains should resolve to the pubilc IP of the DAppNode. But please note, for every subdomain certificate is requested since it uses HTTP chalenges which cannot be used for issuing wildcard certificates.
In this mode, following environment variables have to be set:
It is even possible to run DAppNode on your own domain. Your domain and all of its subdomains should resolve to the pubilc IP of the DAppNode. But please note, for every subdomain a certificate is requested, since it uses HTTP challenges which cannot be used for issuing wildcard certificates.
In this mode, the following environment variables have to be set:
| Name | Value | Description |
| -------------- | --------------------- | ------------------ |
| PUBLIC_DOMAIN | | Your domain |
5 changes: 4 additions & 1 deletion dappnode_package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "HTTPS portal for DAppNode",
"type": "dncore",
"author": "DAppNode Association <[email protected]> (https://github.com/dappnode)",
"license": "GLP-3.0",
"contributors": ["Shardlabs <[email protected]> (https://shardlabs.io/)"],
"architectures": ["linux/amd64", "linux/arm64"],
"categories": ["Developer tools"],
Expand All @@ -15,5 +16,7 @@
"type": "git",
"url": "https://github.com/dappnode/DNP_HTTPS"
},
"license": "GLP-3.0"
"bugs": {
"url": "https://github.com/dappnode/DNP_HTTPS/issues"
}
}

0 comments on commit dfaae72

Please sign in to comment.