## Overview This is a setup guide for people who want to try Pleasanter right away. Here we introduce 3 methods. |No.|Method|Recommended Points| |:-:|:--|:--| |1|Start with demo environment|No setup required. Sample data included.| |2|Start with Docker|Can be used permanently. No feature restrictions.| |3|Start with Pleasanter.net free plan|Can be used permanently. No setup required.| Below, we summarize only the procedures, omitting technical details as much as possible. ## 1. Start with Demo Environment In the demo environment, you can easily try Pleasanter. Please refer to the following PDF for how to use the demo environment. [Read the explanatory PDF](https://pleasanter.org/downloads/get-started-pleasanter.pdf) ## 2. Start with Docker By setting up with Docker, you can use Pleasanter (Community Edition) without feature restrictions permanently. For the procedure, please click "Read detailed explanation" below. <details> <summary>Read detailed explanation</summary> ## Overview Explain the steps to quickly use the Docker version of Pleasanter with the following default environment settings. | No. | Setting | Parameter | Value | Notes | |---|---|---|---|---| | 1 | PostgreSQL version | POSTGRES_VERSION | 17 | | | 2 | Admin user password for PostgreSQL | POSTGRES_PASSWORD | SetSaPWD | | | 3 | Password in the SA connection string | PWD in Implem_Pleasanter_Rds_PostgreSQL<br>_SaConnectionString | SetSaPWD | Set the same value as in No. 2 | | 4 | Password in the Owner connection string | PWD in Implem_Pleasanter_Rds_PostgreSQL<br>_OwnerConnectionString | SetAdminsPWD | | | 5 | Password in the User connection string | PWD in Implem_Pleasanter_Rds_PostgreSQL<br>_UserConnectionString | SetUsersPWD | | | 6 | Pleasanter version | PLEASANTER_VERSION | latest | Fetch the latest version available at the time of use | | 7 | Pleasanter language |The /l option for CodeDefiner|"ja"|| | 8 | Pleasanter timezone |The /z option for CodeDefiner|"Asia/Tokyo"|| ## Procedure The procedure is as follows. 1. [Preparing the Docker Runtime Environment](#preq) 1. [Create and navigate to project directory](#projdir) 1. [Create 2 files](#makefiles) 1. [Run CodeDefiner](#runcodedefiner) 1. [Start and stop Pleasanter](#runpleasanter) <a id="preq"></a> ### 1. Preparing the Docker Runtime Environment Prepare a Docker runtime environment suitable for your OS (e.g., Docker Engine or Docker Desktop). For details, refer to the [official Docker documentation](https://docs.docker.com/) below. - [Docker Engine \| Docker Docs](https://docs.docker.com/engine/) - [Docker Desktop \| Docker Docs](https://docs.docker.com/desktop/) <a id="projdir"></a> ### 2. Create and navigate to project directory Execute the following commands. ``` mkdir ./pleasanter cd ./pleasanter ``` <a id="makefiles"></a> ### 3. Create 2 files Create two files ".env" and "compose.yaml" in the project directory. For Windows (CMD) ``` type nul > .env type nul > compose.yaml ``` For Windows (PowerShell) ``` New-Item .env -ItemType File -Force New-Item compose.yaml -ItemType File -Force ``` For macOS and Linux ```shell touch .env touch compose.yaml ``` #### .env Open .env with a text editor, paste the following content, and save. ```text POSTGRES_VERSION=17 POSTGRES_VOLUMES_TARGET=/var/lib/postgresql/data POSTGRES_USER=postgres POSTGRES_PASSWORD=SetSaPWD POSTGRES_DB=postgres POSTGRES_HOST_AUTH_METHOD=scram-sha-256 POSTGRES_INITDB_ARGS="--auth-host=scram-sha-256" PLEASANTER_VERSION=latest Implem_Pleasanter_Rds_PostgreSQL_SaConnectionString="Server=db;Database=postgres;UID=postgres;PWD=SetSaPWD" Implem_Pleasanter_Rds_PostgreSQL_OwnerConnectionString="Server=db;Database=#ServiceName#;UID=#ServiceName#_Owner;PWD=SetAdminsPWD" Implem_Pleasanter_Rds_PostgreSQL_UserConnectionString="Server=db;Database=#ServiceName#;UID=#ServiceName#_User;PWD=SetUsersPWD" ``` #### compose.yaml Open compose.yaml with a text editor, paste the following content, and save. ```yaml 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 ``` <a id="runcodedefiner"></a> ### 4. Run CodeDefiner In the project directory, execute the following command. ``` docker compose run --rm codedefiner _rds /y /l "en" /z "UTC" ``` <a id="runpleasanter"></a> ### 5. Start and stop Pleasanter #### Start Pleasanter 1. In the project directory, execute the following command. ```shell docker compose up -d pleasanter ``` 1. Open [http://localhost:50001](http://localhost:50001) in your web browser. 1. When the login screen is displayed, enter the following information. |Login ID|Initial Password| |:-:|:-:| |Administrator|pleasanter|  1. Please change to a secure password.  1. Try the [hands-on manual](https://www.pleasanter.org/ja/manual?category=0190). #### Stop Pleasanter 1. Close the web browser. 1. Stop the containers in the project directory. ``` docker compose stop ``` #### Start Pleasanter again 1. Start the containers in the project directory. ```shell docker compose start ``` 1. Open [http://localhost:50001](http://localhost:50001) in your web browser. #### Hands-on After successfully logging in to Pleasanter, Try the [hands-on tutorial](https://www.pleasanter.org/ja/manual?category=0190). </details> ## 3. Start with Pleasanter.net Free Plan With the Pleasanter.net free plan, you can use Pleasanter permanently without the hassle of setup. Please refer to the following PDF for how to use the Pleasanter.net free plan. [Read the explanatory PDF](https://pleasanter.org/downloads/pleasanter_net_start.pdf)