Home

Getting Started

1. Install Ansible on your system (refer to Installing Ansible).
2. Install the Ansible collection.

   ansible-galaxy collection install callum027.palworld_dedicated_server

3. Create an arbitrary folder that contains your Ansible inventory, e.g. /home/user/ansible.
4. In /home/user/ansible, create an inventory folder.
5. Create a file in inventory called hosts.yml, and define the host you want to configure as a member of the palworld group.

   ---
   
   palworld:
     hosts:
       <Insert hostname of Palworld server here>:

6. Create your host-specific inventory configuration file at inventory/host_vars/<Insert hostname of Palworld server here>/palworld.yml (creating any required parent folders), and add the following:

   ---
   
   # For additional options, check the documentation:
   # https://github.com/Callum027/ansible-collection-palworld-dedicated-server/blob/main/README.md
   
   palworld_dedicated_server_admin_password: "<Insert admin password here>"
   
   palworld_dedicated_server_settings:
     PUBLIC_IP: "<Insert public Internet IP of Palworld server here>"
     SERVER_NAME: "<Insert server name here>"
     SERVER_PASSWORD: "<Insert server password here, or leave blank for no password>"
     COMMUNITY_SERVER: false  # Or set to `true` if this will be a community server.
     # Set any additional Palworld server settings here. Same variable names as `default.env`.

7. Run the following command in the /home/user/ansible directory to run the deployment:

   ansible-playbook -i inventory callum027.palworld_dedicated_server.install

8. Palworld Dedicated Server will be installed to /opt/ansible-dedicated-server, with the Docker Compose file being located at /opt/ansible-dedicated-server/docker-compose.yml, and the container data being located at /opt/ansible-dedicated-server/data.