Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
rekby authored May 13, 2019
2 parents 841d2bf + 4988e8a commit 2a556cb
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 8 deletions.
11 changes: 4 additions & 7 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
env:
- GO111MODULE=on GOFLAGS=-mod=vendor CGO_ENABLED=0

language: go

addons:
Expand All @@ -22,18 +19,18 @@ script:

after_script:
# Install and upload test coverage must not failure for test build
- test -n "$TRAVIS_TAG" || go get -mod= golang.org/x/tools/cmd/cover
- test -n "$TRAVIS_TAG" || go get -mod= github.com/mattn/goveralls
- test -n "$TRAVIS_TAG" || go get golang.org/x/tools/cmd/cover
- test -n "$TRAVIS_TAG" || go get github.com/mattn/goveralls
- test -n "$TRAVIS_TAG" || goveralls -coverprofile=coverage.out -service=travis-ci -repotoken $COVERALLS_TOKEN

before_deploy:
- git config --local user.name "$GIT_NAME"
- git config --local user.email "$GIT_EMAIL"
- BUILD_TIME=$(TZ=UTC date --rfc-3339=seconds)
- go get -mod= github.com/mitchellh/gox
- go get github.com/mitchellh/gox
- mkdir -p output
- OS_ARCH_BUILDS="darwin/amd64 linux/386 linux/amd64 linux/arm freebsd/386 freebsd/amd64 freebsd/arm windows/386 windows/amd64"
- gox --mod=vendor -osarch "$OS_ARCH_BUILDS" --ldflags "-X \"main.VERSION=$TRAVIS_TAG+build-$TRAVIS_BUILD_NUMBER, Build time $BUILD_TIME, commit $TRAVIS_COMMIT\"" --output="output/lets-proxy_{{.OS}}_{{.Arch}}" -verbose --rebuild ./cmd/
- GO111MODULE=on CGO_ENABLED=0 gox --mod=vendor -osarch "$OS_ARCH_BUILDS" --ldflags "-X \"main.VERSION=$TRAVIS_TAG+build-$TRAVIS_BUILD_NUMBER, Build time $BUILD_TIME, commit $TRAVIS_COMMIT\"" --output="output/lets-proxy_{{.OS}}_{{.Arch}}" -verbose --rebuild ./cmd/
- bash tests/make_archives.sh

deploy:
Expand Down
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@ Home page: https://github.com/rekby/lets-proxy2

Now it is alpha and not ready for production use.

Features:
* http-01 and tls-alpn-01 validation
* HTTPS (with certificate autoissue) and HTTP reverse proxy
* Zero config for start usage
* Time limit for issue certificate
* Auto include subdomains in certificate (default: domain and www.domain)
* Logging for stderr and/or file
* Self rotate log files (can disable by config)
* Can configure backend in dependence of incoming connection IP:Port
* Custom headers to backend
* Self check domain before issue cert (prevent DoS cert issue attack by requests with bad domains)
* Blacklist/whitelist of domains
* Lock certificates (force to use manual issued certificate without internal checks)

It is next generation of https://github.com/rekby/lets-proxy, rewrited from scratch.

It is improove logging and internal structure for better test coverage and simpler support.
Expand All @@ -35,13 +49,27 @@ Use --help key for details:

./lets-proxy --help or lets-proxy.exe --help


Русский (Russian):
==================
Сайт программы: https://github.com/rekby/lets-proxy2

Сейчас это тестовая версия, программа в процессе разработчик и она не готова для реального использования.

Возможности:
* Авторизация доменов по протоколам http-01 and tls-alpn-01
* Проксирование HTTPS (с автовыпуском сертификата) and HTTP
* Начать использование можно без настроек
* Ограничение времени на получение сертификата
* Автоматическое получение сертификата для домена и поддоменов (default: domain and www.domain)
* Вывод логов в файл и/или на стандартный вывод ошибок
* Самостоятельная ротация лог-файлов (отключается в настройках)
* Можно настроить адрес перенаправления запроса в заивисмости от адреса приема запроса.
* Настраиваемые дополнительные заголовки для передачи на внутренний сервер
* Самостоятельная проверка возможности выпуска сертификата перед его запросов (для исключения DoS-атак путем запросов с неправильными доменами)
* Белый/чёрный списки доменов для выпуска сертификатов
* Фиксированный сертификат (возможность использовать самостоятельно полученный сертификат, без внутренних проверок и автообновления)


Эта программа - следующая итерация после https://github.com/rekby/lets-proxy, переписанная с нуля.

Улучшено логирование, внутреннее устройство кода - для упрощения тестирования и поддержки/развития.
Expand Down
2 changes: 2 additions & 0 deletions tests/make_archives.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
set -ev

cd output
ls

./lets-proxy_linux_amd64 --print-default-config > config_default.toml_


Expand Down

0 comments on commit 2a556cb

Please sign in to comment.