At Senzing, we strive to create GitHub documentation in a "don't make me think" style. For the most part, instructions are copy and paste. Whenever thinking is needed, it's marked with a "thinking" icon :thinking:. Whenever customization is needed, it's marked with a "pencil" icon :pencil2:. If the instructions are not clear, please let us know by opening a new Documentation issue describing where we can improve. Now on with the show...
The senzing/init-container performs Senzing initializations.
Synopsis:
*.template files into actual files.ini files.SYS_CFG table with default configuration.:thinking: The following tasks need to be complete before proceeding. These are "one-time tasks" which may already have been completed.
apt based installation for Debian, Ubuntu and
others
yum based installation for Red Hat, CentOS, openSuse and
others.
Get a local copy of init-container.py. Example:
:pencil2: Specify where to download file. Example:
export SENZING_DOWNLOAD_FILE=~/init-container.py
Download file. Example:
curl -X GET \
--output ${SENZING_DOWNLOAD_FILE} \
https://raw.githubusercontent.com/Senzing/docker-init-container/main/init-container.py
Make file executable. Example:
chmod +x ${SENZING_DOWNLOAD_FILE}
:thinking: Alternative: The entire git repository can be downloaded by following instructions at Clone repository
:pencil2: Identify the Senzing g2 directory.
Example:
export SENZING_G2_DIR=/opt/senzing/g2
Here's a simple test to see if SENZING_G2_DIR is correct.
The following command should return file contents.
Example:
cat ${SENZING_G2_DIR}/g2BuildVersion.json
Set common environment variables Example:
export PYTHONPATH=${SENZING_G2_DIR}/sdk/python
:thinking: Set operating system specific environment variables. Choose one of the options.
Run the command. Example:
sudo \
PYTHONPATH=${PYTHONPATH} \
LD_LIBRARY_PATH=${LD_LIBRARY_PATH} \
${SENZING_DOWNLOAD_FILE} --help
For more examples of use, see Examples of CLI.
:thinking: The following tasks need to be complete before proceeding. These are "one-time tasks" which may already have been completed.
:thinking: Optional: Some databases need additional support. For other databases, these steps may be skipped.
SENZING_OPT_IBM_DIR_PARAMETER.SENZING_OPT_MICROSOFT_DIR_PARAMETER.:thinking: Optional: Use if storing data in an external database. If not specified, the internal SQLite database will be used.
:pencil2: Specify database. Example:
export DATABASE_PROTOCOL=postgresql
export DATABASE_USERNAME=postgres
export DATABASE_PASSWORD=postgres
export DATABASE_HOST=senzing-postgresql
export DATABASE_PORT=5432
export DATABASE_DATABASE=G2
Construct Database URL. Example:
export SENZING_DATABASE_URL="${DATABASE_PROTOCOL}://${DATABASE_USERNAME}:${DATABASE_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${DATABASE_DATABASE}"
Construct parameter for docker run.
Example:
export SENZING_DATABASE_URL_PARAMETER="--env SENZING_DATABASE_URL=${SENZING_DATABASE_URL}"
Although the Docker run command looks complex,
it accounts for all of the optional variations described above.
Unset environment variables have no effect on the
docker run command and may be removed or remain.
Run Docker container. Example:
sudo docker run \
--rm \
${SENZING_DATABASE_URL_PARAMETER} \
${SENZING_OPT_IBM_DIR_PARAMETER} \
${SENZING_OPT_MICROSOFT_DIR_PARAMETER} \
senzing/init-container
For more examples of use, see Examples of Docker.
Configuration values specified by environment variable or command line parameter.
Content type
Image
Digest
sha256:fd596745a…
Size
1.8 GB
Last updated
about 1 year ago
docker pull senzing/init-container