Launch with Docker

1. Create Project Directory¶

Create a project directory in any location to store the two files ".env" and "compose.yaml" that will be explained in the next section. The directory name can be anything.

2. Create .env File¶

Create a ".env" file containing environment variables such as user and password used for initdb to initialize PostgreSQL, and Pleasanter database connection string settings. The configuration details are as follows:

Environment variables starting with POSTGRES are used by the PostgreSQL official Docker image. When the container is initialized, initdb is executed and PostgreSQL initial settings are configured using the environment variable values.
- postgres - Official Image | Docker Hub
- docker-library/postgres: Docker Official Image packaging for Postgres

For details on connection strings, please refer to the following manual:
- Rds.json

Here is an example file. Modify {{ ... }} as appropriate and save as .env in the project directory.

POSTGRES_VERSION={{PostgreSQL Version}}
POSTGRES_VOLUMES_TARGET={{Volumes TargetPath}}
POSTGRES_USER=postgres
POSTGRES_PASSWORD={{Sa Password}}
POSTGRES_DB=postgres
POSTGRES_HOST_AUTH_METHOD=scram-sha-256
POSTGRES_INITDB_ARGS="--auth-host=scram-sha-256"
PLEASANTER_VERSION={{Pleasanter Version}}
Implem_Pleasanter_Rds_PostgreSQL_SaConnectionString="Server=db;Database=postgres;UID=postgres;PWD={{Sa Password}}"
Implem_Pleasanter_Rds_PostgreSQL_OwnerConnectionString="Server=db;Database=#ServiceName#;UID=#ServiceName#_Owner;PWD={{Owner password}}"
Implem_Pleasanter_Rds_PostgreSQL_UserConnectionString="Server=db;Database=#ServiceName#;UID=#ServiceName#_User;PWD={{User password}}"

3. Docker Compose File¶

Create a compose.yaml file with the following content:

services:
  db:
    container_name: postgres
    image: postgres:${POSTGRES_VERSION}
    environment:
      - POSTGRES_USER
      - POSTGRES_PASSWORD
      - POSTGRES_DB
      - POSTGRES_HOST_AUTH_METHOD
      - POSTGRES_INITDB_ARGS
    volumes:
      - type: volume
        source: pg_data
        target: ${POSTGRES_VOLUMES_TARGET}
  pleasanter:
    container_name: pleasanter
    image: implem/pleasanter:${PLEASANTER_VERSION}
    depends_on:
      - db
    ports:
      - '50001:8080'
    environment:
      Implem.Pleasanter_Rds_PostgreSQL_SaConnectionString: ${Implem_Pleasanter_Rds_PostgreSQL_SaConnectionString}
      Implem.Pleasanter_Rds_PostgreSQL_OwnerConnectionString: ${Implem_Pleasanter_Rds_PostgreSQL_OwnerConnectionString}
      Implem.Pleasanter_Rds_PostgreSQL_UserConnectionString: ${Implem_Pleasanter_Rds_PostgreSQL_UserConnectionString}
  codedefiner:
    container_name: codedefiner
    image: implem/pleasanter:codedefiner
    depends_on:
      - db
    environment:
      Implem.Pleasanter_Rds_PostgreSQL_SaConnectionString: ${Implem_Pleasanter_Rds_PostgreSQL_SaConnectionString}
      Implem.Pleasanter_Rds_PostgreSQL_OwnerConnectionString: ${Implem_Pleasanter_Rds_PostgreSQL_OwnerConnectionString}
      Implem.Pleasanter_Rds_PostgreSQL_UserConnectionString: ${Implem_Pleasanter_Rds_PostgreSQL_UserConnectionString}
volumes:
  pg_data:
    name: ${COMPOSE_PROJECT_NAME:-default}_pg_data_volume

The file layout should be as follows:

./projectDirectory
|-- .env
|-- compose.yaml

2. Execute CodeDefiner¶

Execute CodeDefiner with the following command in the project directory:

docker compose run --rm codedefiner _rds /l "<language>" /z "<timezone>"

(※1) For language and timezone, please refer to the following manual page:
FAQ: I want to know the parameter setting values for languages and timezones supported by Pleasanter

For use in a Japanese environment, use the following command:

docker compose run --rm codedefiner _rds /l "ja" /z "Asia/Tokyo"

When "Type "y" (yes) if the license is correct, otherwise type "n" (no)." is displayed, enter y.

※The version is output to the console log as follows. The version displayed here is always "the latest version of Pleasanter published on DockerHub". This console log display specification applies even when a version earlier than the latest is specified in {{Version}} in compose.yaml, but the database is created with content compliant with {{Version}}, so there are no operational issues with Pleasanter.

<INFO> Starter.Main: Implem.CodeDefiner 1.5.0.0

3. Launch Pleasanter¶

Execute the following command in the project directory to create containers and launch Pleasanter:

docker compose up -d pleasanter

Access the following URL in your browser:

http://localhost:50001

On the login screen, enter "Login ID: Administrator" and "Initial Password: pleasanter". After logging in, you will be prompted to change your password, so set an appropriate password.

4. Stop and Remove Containers¶

To stop containers, execute the following command in the project directory:

docker compose stop

To restart stopped containers, execute the following command in the project directory:

docker compose start

Stopping containers does not delete DB data. The data can be used as-is when restarting.

To remove containers, execute the following command in the project directory. Removing containers does not delete DB data (volumes). Note that once containers are removed, they cannot be restarted.

docker compose down

If you want to launch again after removing containers, create containers by executing the following command in the project directory. This will also create the DB container and the remaining DB data can be used as-is.

docker compose up -d pleasanter

To delete data (volumes) at the same time when removing containers, execute with the option to delete volumes:

docker compose down -v