From 76415d2f31323dc4821238a34b9380fc68240cca Mon Sep 17 00:00:00 2001 From: Becca Petrin Date: Mon, 13 Jul 2020 16:28:39 -0700 Subject: [PATCH] Release/0.1.1 (#137) * Add installation instructions (#129) * Add installation instructions * Update installation page to include links * Update instructions * Add Metadata to Python SDK (#134) * Add Python metadata * Update pyproject.toml * Update pyproject.toml * Fix broken config (#136) Co-authored-by: Dio Gado --- authenticator/main.go | 27 +------------------- docs/docs/installation.mdx | 50 ++++++++++++++++++++++++++++++++++++++ docs/docs/overview.md | 3 +++ sdk/python/pyproject.toml | 4 ++- 4 files changed, 57 insertions(+), 27 deletions(-) create mode 100644 docs/docs/installation.mdx diff --git a/authenticator/main.go b/authenticator/main.go index 6c560c23..1b918300 100644 --- a/authenticator/main.go +++ b/authenticator/main.go @@ -1,7 +1,6 @@ package main import ( - "flag" "fmt" "os" "os/signal" @@ -13,32 +12,8 @@ import ( log "github.com/sirupsen/logrus" ) -var devMode bool - -func init() { - flag.BoolVar(&devMode, "dev", false, "run in dev mode") -} - func main() { - flag.Parse() - - var c config.Config - var err error - if devMode { - // dev mode uses the file back-end - os.Unsetenv("VAULT_ADDR") - c = config.Config{ - Host: "127.0.0.1", - HTTPPort: 6000, - GRPCPort: 6001, - DisableTLS: true, - LogLevel: "debug", - LogFormat: "text", - LogRaw: false, - } - } else { - c, err = config.ParseConfig() - } + c, err := config.ParseConfig() if err != nil { log.Errorf("couldn't parse config: %s", err) return diff --git a/docs/docs/installation.mdx b/docs/docs/installation.mdx new file mode 100644 index 00000000..427dbc7b --- /dev/null +++ b/docs/docs/installation.mdx @@ -0,0 +1,50 @@ +--- +title: Installation +--- + +## Client SDKs + +- Python: `pip3 install approzium` + +## Authentication server binaries + +- Our binaries are posted with [our releases](https://github.com/cyralinc/approzium/releases). + +## Running the server binary + +### Linux + +Please replace `linux_amd64.zip` with the correct version of Linux for your environment. + +``` +curl https://github.com/cyralinc/approzium/releases/download/v0.1.0/linux_amd64.zip +unzip linux_amd64.zip +chmod +x authenticator +./authenticator +``` + +### Mac + +Please replace `darwin_amd64.zip` with the correct version of Mac for your environment. + +``` +curl https://github.com/cyralinc/approzium/releases/download/v0.1.0/darwin_amd64.zip +unzip darwin_amd64.zip +chmod +x authenticator +./authenticator +``` + +### Windows + +Please replace `windows_amd64.zip` with the correct version of Windows for your environment. + +``` +$url = "https://github.com/cyralinc/approzium/releases/download/v0.1.0/windows_amd64.zip" +$outpath = "$PSScriptRoot/windows_amd64.zip" +Invoke-WebRequest -Uri $url -OutFile $outpath +$wc = New-Object System.Net.WebClient +$wc.DownloadFile($url, $outpath) +$args = @("Comma","Separated","Arguments") +Expand-Archive -LiteralPath $outpath -DestinationPath C:\ $PSScriptRoot +Start-Process -Filepath "$PSScriptRoot/authenticator.exe" -ArgumentList $args +``` diff --git a/docs/docs/overview.md b/docs/docs/overview.md index 6a520cf0..8c1c7409 100644 --- a/docs/docs/overview.md +++ b/docs/docs/overview.md @@ -16,6 +16,9 @@ Additionally, Approzium addresses common security vulnerabilities in how applica ```python from psycopg2 import connect +# In your environment, the password may be pulled from any place, S3, a config +# file, HashiCorp Vault, or wherever. But wherever it originates, it can be +# leaked by your client application because it's in memory. conn = connect("host=1.2.3.4 user=user1 password=verySecurePassword") ``` diff --git a/sdk/python/pyproject.toml b/sdk/python/pyproject.toml index 596cdc5e..5f6eaa71 100644 --- a/sdk/python/pyproject.toml +++ b/sdk/python/pyproject.toml @@ -6,7 +6,9 @@ build-backend = "poetry.masonry.api" name = "approzium" version = "0.1.1" description = "Approzium SDK provides Approzium database authentiation for Python" -authors = ["Cyral "] +authors = ["Cyral "] +homepage = "https://github.com/cyralinc/approzium" +license = "Apache-2.0" [tool.poetry.dependencies] python = "^3.5"