Data Initialization

If you are deploying Casdoor with other services as a complete application, you may want to provide an out-of-the-box feature for users. This means that users can directly use the application without any configuration.

In such a situation, you can use data initialization to register your service in Casdoor through a configuration file. This file can be pre-defined or dynamically generated by your own service.

How to use

If there is a configuration file named init_data.json at the root directory of Casdoor, it will be used to initialize data in Casdoor. All you have to do is place this file in the root directory where Casdoor will run.

If you are using the official Docker image of Casdoor, here are some scripts that can help you to mount init_data.json into the container.

Docker

If you deploy Casdoor with Docker, you can use the volume command to mount init_data.json into the container.

docker run ... -v /path/to/init_data.json:/init_data.json

Kubernetes

If you deploy Casdoor with Kubernetes, you can use the configmap to store init_data.json.

apiVersion: v1
kind: ConfigMap
metadata:
  name: casdoor-init-data
data:
  init_data.json:

You can mount the data into Casdoor pods by mounting the configmap. You can modify your deployment as follows:

apiVersion: apps/v1
kind: Deployment
...
spec:
  template:
    ...
    spec:
      containers:
      ...
        volumeMounts:
        - mountPath: /init_data.json
          name: casdoor-init-data-volume
          subPath: init_data.json
      volumes:
      - configMap:
          name: casdoor-init-data
        name: casdoor-init-data-volume

File details

There is already a template named init_data.json.template in the root directory of Casdoor repository. You can refer to this file to customize your initialization.

The following is the Go struct of each part and their documentation:

Object	Go Struct	Documentation
organizations	struct	doc
applications	struct	doc
users	struct	doc
providers	struct	doc
certs	struct
ldaps	struct	doc

If you still feel confused about filling out this template, you can call the RESTful API or use the debug mode of your browser to see the response of GetXXX to these objects. The responses are in the same format as init_data.json.