Skip to main content

​
Prerequisites

  • A Dokploy account with access to a server
  • Docker support enabled on your Dokploy instance

​
Deployment Steps

1

Create or access your project

If you don’t have a project yet, create a new one in Dokploy. Navigate to your project dashboard once created.
2

Create a new service from template

In your project, create a new service:
  1. Choose Template as the service type
  2. Search for Openinary in the search bar
  3. Click Create then Confirm
A new service named “Openinary” will appear in your project.
3

Configure environment variables

The environment variables are already pre-configured with placeholders. You’ll see variables like:
IMAGE_TAG=latest
BETTER_AUTH_SECRET=your-sha256-hash-or-long-secret
BETTER_AUTH_URL=your-base-url
ALLOWED_ORIGIN=your-base-url
NEXT_PUBLIC_API_BASE_URL=/api
Make sure the BETTER_AUTH_URL and ALLOWED_ORIGIN are your base URL (the domain where Openinary will be accessible).
The template is pre-configured for local storage. No additional environment variables are needed.
4

Configure your domain (recommended)

Before deploying for the first time, it’s highly recommended to configure your custom domain if desired.
Navigate to the Domains tab and set up your domain configuration. While not mandatory, we strongly recommend using HTTPS for production deployments.
5

Deploy your application

Once your environment variables and domain are configured:
  1. Navigate to the Environment tab to verify everything is correct
  2. Click the Deploy button
  3. Click Confirm to start the deployment
We recommend watching the logs during the first deployment to ensure everything runs smoothly.
The first deployment will begin. If everything goes well, you should see this message at the end:
Docker Compose Deployed: ✅
Your Openinary instance is now deployed!
6

Access your instance

Navigate to the Domains tab and visit the generated URL or your configured custom domain.
7

Initial setup

You should land on the initial setup page where you can create your administrator account.
Important: Create your admin account immediately after deployment, as the setup route is publicly accessible until completed.
After signing in, you should see the sample assets or your bucket content in the Dashboard.
Openinary is now fully configured and ready to use!

​
Troubleshooting

If you encounter any issues during deployment:
  1. Check the deployment logs in Dokploy for error messages
  2. Verify all environment variables are correctly set
  3. Ensure your domain DNS is properly configured (if using a custom domain)
If problems persist, please create an issue on GitHub with your deployment logs.

​
Next Steps

Now that your Openinary instance is running, learn how to use it:

Transform Images

Learn how to transform and optimize images

Transform Videos

Learn how to transform and process videos