api

command module
v0.0.0-...-f28940e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 28, 2022 License: MIT Imports: 7 Imported by: 0

README

CateiruSSO API

codecov Lint

環境変数

# デプロイモード
# `production` or other
# `production`を設定するとdebugログが表示されません
DEPLOY_MODE=

# datastoreのホスト
# 通常、GCPサービス上にデプロイされると自動で追加されます
DATASTORE_EMULATOR_HOST=

# datastoreのプロジェクトID
DATASTORE_PROJECT_ID=

# ワンタイムパスワードなどに表示するISSUER
# サービス名
ISSUER=

# reCAPTCHAのsecret
RECAPTCHA_SECRET=

# mail gunのAPI KEY
# メール送信に使用します
MAILGUN_API_KEY=

# メール送信者のドメイン
MAIL_FROM_DOMAIN=

# メール送信者のメールアドレス
SENDER_MAIL_ADDRESS=

# Datastoreの親レベルのkey名
# デフォルトは`cateiru-sso`です
DATASTORE_PARENT_KEY=

# サイトのドメイン(パス)
SITE_DOMAIN=

# APIのドメイン(パス)
API_DOMAIN=

# cookieに適用するドメイン
# サイト、APIのドメインのルートドメインである必要があります
COOKIE_DOMAIN=

# adminのメールアドレスとパスワード
# 初回ログイン時にこの値を使用します
# adminユーザは、ログイン後、ワンタイムパスワードとパスワードの変更をする必要があります
ADMIN_MAIL=
ADMIN_PASSWORD=

# cloud storageのURL
STORAGE_URL=

# workerのパスワード
WORKER_PASSWORD=

テスト

make test

Dev

make dev
[カスタム] DBの実行
# start db
docker-compose up -d

# stop db
docker-compose down --rmi all

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
core
common
- メールアドレスの存在チェック - IPアドレスがブロックリストに存在するかチェック
- メールアドレスの存在チェック - IPアドレスがブロックリストに存在するかチェック
me
pro
tests
ハッシュ生成
ハッシュ生成
mail
メールを送信します。
メールを送信します。
net
Cookieの作成、取得、削除を行います。
Cookieの作成、取得、削除を行います。
secure
ワンタイムパスワードを作成、検証します。
ワンタイムパスワードを作成、検証します。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL