Skip to main content
Prerequisites
  1. Ensure you have administrative access to the server running the Draftable API Self-Hosted instance.
  2. Verify that Docker and Docker Compose are installed on the server.

​
Steps to Update the Draftable API Self-Hosted Instance

1
Pull the Latest Docker ImageUse the docker pull command to download the latest image from the Draftable repository:docker pull draftable/apish:latest This command ensures that the most recent version of the image is downloaded to your server.
2
Update the docker-compose.yml FileThe docker-compose.yml file defines how your container is configured and deployed. Locate this file in the directory where your Draftable API instance is hosted.
  • Open the file in a your preferred text editor.
  • Update the image field under the services section to ensure it references the latest image:
version: '3.5'
services:
  apish: 
    environment:    
      DRAFTABLE_APISH_NGINX: |-          
    image: draftable/apish:latest #The term 'Latest' always ensures you are using the latest version
    ports:
       - 80:80/tcp         
       - 0.0.0.0:8440:443/tcp      
    volumes:       
      - draftable-apish:/srv/draftable
      - /sys/fs/cgroup:/sys/fs/cgroup   
volumes: 
  draftable-apish:
  • Save and exit the editor
3
Restart the ContainerTo apply the updates, restart your container with the updated configuration:Start by shutting down the container:docker-compose downThen restart the container with:
docker-compose upTo apply the updates, restart your container with the updated configuration:Start by shutting down the container:docker-compose downThen restart the container with:
docker-compose upYou should see the container begin to restart, now using the latest image specified. 
4
Verify the Update
  • Check that the container is running:
docker ps
  • Navigate to your instance’s web interface or API endpoint to confirm it is operational.
  • You can also confirm the version of Self Hosted, by navigating to the Admin page and checking the bottom left corner. 
If you have any issues following the above information or questions in general, please get in contact with us at support@draftable.com.