Run Plauti Server on different Operating Systems via Docker.
If you want to run Plauti Server on an OS that is not supported for Plauti Server, such as Win-arm or Linux AMD64, you can run it via Docker instead. The only requirement is that your server has the latest Docker version installed.
Prerequisites
- You have the latest version of Docker installed.
Key Points
- The server runs on port 8881 by default.
- Data is stored in the
plauti-datavolume for persistence. - Use a
.envfile to set environment variables. See Environment Values - You can use either
.envorenv.propertiesfor your environment file.
Quick Start using CLI
In a terminal, run the following commands:
- Pull the latest Plauti Server image:
docker pull ghcr.io/plauti/plauti-server:latest - Create a volume for data persistence:
docker volume create plauti-data - Configure either your Salesforce Production Org ID, or your Dynamics Tenant ID, and run the server.
Note that you can always change the org or tenant ID, or add more connections, once the app is set up.docker run -d --name plauti-server -p 8881:8881 \-v plauti-data:/root/.local/share/.plauti \-e DOCKER="true" \-e SF_ORGANIZATION_ID=<your-sf-organization-id> \-e MS_TENANT_ID=<your-ms-tenant-id> \ghcr.io/plauti/plauti-server
By default Plauti Server runs on http://localhost:8881/ . -e DOCKER="true" \ is mandatory when running on Docker.
Options:
-d is for detached mode, making your terminal usable again after spinning up the docker container.-e is for environment variables. It can be used to set individual variables (-e KEY=value) or to load from a file (--env-file .env). See Environment Values for a list of all available settings. If you are running on Docker Desktop, environment variables can also be changed by editing the .env.properties inside the container files.-v is for the volume, where the data is stored, use /root/.local/share/.plauti to store the plauti files.-p is for the port, internal:external, has to match the env PORT value.
Using Docker Compose
- Create a
docker-compose.ymlfile:services: plauti-server: image: ghcr.io/plauti/plauti-server ports: - '8881:8881' volumes: - plauti-data:/root/.local/share/.plauti env_file: - .env volumes:plauti-data: {} - Run with Docker Compose:
docker compose up -d
Managing the Server
- Stop the server:
docker stop plauti-server - Start the server:
docker start plauti-server - Restart the server:
docker restart plauti-server - View server logs:
docker logs -f plauti-server
Allowing IP addresses
Salesforce
- If your Salesforce Org has restrictions in force for incoming calls, whitelist your server in Salesforce.
Add the IP address of the server where you installed Plauti Server to the Login IP Ranges of the Profile that you will use to log into Salesforce, and to the Network Access settings in Salesforce Setup. - Furthermore, make sure that the server where you installed Plauti Server can reach the following sites:
- https://login.salesforce.com
- your Salesforce Org (yoursalesforceorg.my.salesforce.com)
- https://plautiapps.blob.core.windows.net
MS Dynamics
- Make sure that the server where you installed Plauti Server can reach the following sites:
- https://login.microsoftonline.com (Azure AD authentication)
- Your Dynamics 365 instance URL (yourorg.crm.dynamics.com)
- https://plautiapps.blob.core.windows.net