サーバーインストール

要件

オペレーティングシステム

Windows、Linux、macOSを含むすべての主要なオペレーティングシステムがサポートされています。

環境

• Go 1.20+
• Node.js LTS (18)
• Yarn 1.x

情報

Casibaseの使用は2つのステップに分かれています:

• ステップ1: Casdoorの配置と実行
• step2: Casibase(このドキュメント) のデプロイと実行

[Yarn 1] を使うことを強くお勧めします。 ](https://classic.yarnpkg.com/en/docs/install) を実行してビルドする Casidor&Casibase frontend を NPM を使用すると、UI のスタイリングの問題が発生する可能性があります。詳細は casdoor#294 を参照してください。

警告

中国のユーザーの場合、Go依存関係を正常にダウンロードするには、GOPROXY環境変数を設定してGoプロキシを使用する必要があります。次のサイトを強くお勧めします: https://goproxy.cn/ 強く推奨します: https://goproxy.cn/

データベース

Casibaseは、データベースとの通信に XORM を使用します。 Casibaseは現在、Xormドライバサポートに基づき、以下のデータベースをサポートしています。

• MySQL
• MariaDB
• PostgreSQL
• CockroachDB
• SQL Server
• Oracle
• SQLite 3
• TiDB

guacd

Casibaseはguacamole-serverを使用してリモートデスクトップアクセスを提供します。 この機能を使用するには、まず guacamole-server をインストールする必要があります。 もしguacamole-serverがインストールされていない場合は、guacamole-serverのインストールを参照してください。

次のコマンドを使用してDockerでguacdを実行することもできます:

docker run -d --name guacd -p 4822:4822 guacamole/guacd

ダウンロード

CasibaseのソースコードはGitHub: https://github.com/casibase/casibase でホストされています。 GoバックエンドのコードとReactフロントエンドのコードは、単一のリポジトリ内にあります。

名前	説明	言語	ソースコード
フロントエンド	Casibase用WebフロントエンドUI	JavaScript + React	https://github.com/casibase/casibase/tree/master/web
バックエンド	CasibaseのRESTful APIバックエンド	Golang + Beego + XORM	https://github.com/casibase/casibase

CasibaseはGo Modulesをサポートしています。 コードをダウンロードするには、gitを使ってリポジトリをクローンするだけです：

cd path/to/folder
git clone https://github.com/casibase/casibase

設定

Casdoorの設定

Casdoorを設定するには、Casdoor-SSOセクションを参照してください。

後で使用するclientId、clientSecret、organization、applicationなどのCasdoor設定情報を覚えておいてください。

データベースの設定

Casibase supports mysql, mssql, sqlite3, postgres. Casibaseはデフォルトでmysqlを使用します。

MySQL

Casibaseは、ユーザー、ノード、トピック情報をcasibaseという名前のMySQLデータベースに保存します。 データベースが存在しない場合は、手動で作成する必要があります。 DB 接続文字列を指定することができます: https://github.com/casibase/casibase/blob/master/conf/app.conf

driverName = mysql dataSourceName = root:123456@tcp(localhost:3306)/ dbName = casibase

PostgreSQL

xormでPostgresを開く際にはデータベースを選択する必要があるので、Casibaseを実行する前に手動でデータベースを準備する必要があります。

casibaseという名前のデータベースが既に用意されているとします。次のようにapp.confを指定する必要があります。

driverName = postgres dataSourceName = "user=postgres password=postgres host=localhost port=5432 sslmode=disable dbname=casibase" dbName =

情報

PostgreSQLの場合、dataSourceNameに空でないdbNameがあることを確認し、上記の例のように別のdbNameフィールドを空のままにしてください。

CockroachDB

postgresドライバーでCockroachdbを使用することもできます。設定はPostgreSQLと同じです。 PostgreSQLと同じ設定になっています。

driverName = postgres dataSourceName = "user=postgres password=postgres host=localhost port=5432 sslmode=disable dbname=casibase serial_normalization=virtual_sequence" dbName =

情報

CockroachDBの場合、上記の例のようにdataSourceNameにserial_normalization=virtual_sequenceを追加することを忘れないでください。そうしないと、サービスが起動または再起動するたびに、データベースがすでに存在するというエラーが発生します。これはデータベースが作成される前に追加する必要があることに注意してください。 さもなければ、サービスの開始または再起動時に既存のデータベースに関するエラーが発生します。 注意：これはデータベース作成前に追加する必要があります。

Sqlite3

app.confは次のように指定する必要があります:

driverName = sqlite
dataSourceName = "file:casibase.db?cache=shared"
dbName = casibase

カスタム設定

Casibaseはカスタム設定をサポートしています。設定ファイルconf/app.confを変更して設定を変更できます。

• バックエンド (conf/app.conf)

casdoorEndpoint = <Casdoorエンドポイント>
clientId = <CasdoorアプリケーションのクライアントID>
clientSecret = <Casdoorアプリケーションのクライアントシークレット>
casdoorOrganization = <Casdoor組織名>
casdoorApplication = <Casdoorアプリケーション名>

• フロントエンド (web/src/Conf.js)

serverUrl: "<Casdoorエンドポイント>"
clientId: "<CasdoorアプリケーションのクライアントID>" 
appName: "<Casdoorアプリケーション名>"
organizationName: "<Casdoor組織名>"

実行

現在、2つの起動方法があり、状況に応じて1つを選択できます。

警告

Casibase はアクセス制御とバックエンドサービスを提供するために Casidoor を必要としますので、 Casibase を実行する前に Casdoor が正しく実行されていることを確認する必要があります。

Casdoorのインストールと実行方法:

• Casdoorインストール

開発モード

バックエンド

CasibaseのGoバックエンドはデフォルトでポート14000で動作します。 次のコマンドでGoバックエンドを起動できます：

go run main.go

サーバーが正常に実行された後、フロントエンド部分を起動できます。

フロントエンド

Casibaseのフロントエンドは非常に古典的なCreate-React-App (CRA)プロジェクトです。 デフォルトではポート13001で実行されます。 フロントエンドを実行するには、次のコマンドを使用します：

cd web
yarn install
yarn start

本番モード

バックエンド

Casibaseをビルドする バックエンドコードを実行可能にして起動します。

Linuxの場合:

Go build
./casibase

Windowsの場合:

go build
casibase.exe

フロントエンド

Casibaseフロントエンドコードを静的リソースにビルドします (.html, .js, .cssファイル):

cd web
yarn install
yarn build

Nginx

ヒント

nginxをリバースプロキシとして使用する場合、nginx設定ファイルに次の設定を追加する必要があります:

location / {
    *** あなたの設定 ***
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
}

Casibaseはguacdと通信するためにwebsocketを使用しています。

プレビュー

ブラウザでhttp://localhost:13001にアクセスしてください。 Casibaseダッシュボードに、Casdoorに登録したばかりのユーザーアカウントでログインします。

次に、Casibaseのホームページに移動します:

ヒント

別のポートを使用するには、conf/app.confを編集してhttpportを変更し、Goバックエンドを再起動してください。