Şükrü

Deploy Squidex HeadlessCMS on Railway with one click, start for free. Deploy a headless cms with ease

Squidex HeadlessCMS

Home

Deploy

Railway is a platform that makes it easy to deploy and manage your applications in the cloud.

Railway

You can deploy Squidex HeadlessCMS on Railway by clicking the "Deploy Now" button on this page. Railway will automatically set up all the necessary services and configurations for you.

How do I deploy Squidex HeadlessCMS on Railway?

Railway handles all the infrastructure requirements. You only need a web browser to deploy and manage your application.

What are the system requirements?

Yes, this template is free to use within your existing Railway account.

Is this template free to use?

Yes, you can fully customize this template. After deployment, you will have full control of what you've deployed in your Railway project.

Can I customize this template?

You can get support through our community forum: squidex-headless-cms-c5dacc7c, or join our Discord community for more assistance.

How do I get support for this template?

Deploy and Host Squidex HeadlessCMS on Railway with one click. No maintenance required, free trial available.

Free trial available, paid plans from $5/month

How to Deploy Squidex HeadlessCMS on Railway in seconds

Start Squidex HeadlessCMS deployment

Click the 'Deploy Now' button to begin deploying Squidex HeadlessCMS on Railway's cloud infrastructure

Authenticate your account

Sign in with your GitHub account to connect Railway with your code

Configure deployed Squidex HeadlessCMS instance

Railway automatically provisions a project for Squidex HeadlessCMS. Make optional custom changes to Squidex HeadlessCMS in project settings such as environment variables and service configurations.

squidex

True to delete apps permanently. This process can take a while and is executed in the background.

The access key for your user. Read More: https://supsystic.com/documentation/id-secret-access-key-amazon-s3/

True, to disable the SigV4 payload signing. This might be needed for some S3-compatible storage solutions, for example Cloudflare R2.

Force path style property for AmazonS3Config

The secret key for your user. Read More: https://supsystic.com/documentation/id-secret-access-key-amazon-s3/

The url of the S3 API service. Leave it empty if using the one provided by Amazon

The connection string to the azure storage service.

The name of the container in the Azure Blob Storage

To create the subfolder if it does not exist. Set it to false it the Squidex process has limited permissions.

The relative or absolute path to the folder to store the assets.

The name of the bucket in google cloud store.

The connection string to your Mongo Server. Read More: https://docs.mongodb.com/manual/reference/connection-string/

Define the type of the read store. SUPPORTED: Folder (local folder), MongoDb (GridFS), GoogleCloud (hosted in Google Cloud only), AzureBlob, AmazonS3, FTP (not recommended).

Deliver the assets in AVIG format automatically if the browser supports that. WARNING: If you change this feature from false to true, you might experience a performance spike the images are getting prepared.

Deliver the assets in WEBP format automatically if the browser supports that. WARNING: If you change this feature from false to true, you might experience a performance spike the images are getting prepared.

True to enable memory caching. This is only supported in GraphQL with the @cache(duration: 1000) directive.

The default page size if not specified by a query. Warning: Can slow down queries if increased.

Create one folder per app. WARNING: If you change this parameter, previous assets are not available anymore.

The maximum number of items to return for each query. Warning: Use pagination and not large number of items.

The maximum file size in bytes. Default: 5MB

The timeout when searching for single items in the database.

The timeout when searching for multiple items in the database.

Restrict the surrogate keys to the number of characters.

OBSOLETE - Set to true to enable a replicated cache for app, schemas and rules. Increases performance but reduces consistency. This setting is obsolete and has been replaced with caching:apps:cacheDuration and caching:schemas:cacheDuration

Until version 7, Squidex uses Microsoft Orleans for clustering. It is technology, which was written for online games, such as Halo. With Orleans you develop small classes that are deployed automatically to a cluster of nodes. To enable clustering you have to set this setting to Mongo, which means that a MongoDB table is used to store the state of the cluster.

Defines whether the current instance is a worker. You should have only one worker in your deployment.

Indicates if responses over HTTPS connections should be compressed.

The compression level for brotli. SUPPORTED: Fastest (default), OptimOptimal, SmallestSize, NoCompression

The compression level for gzip. SUPPORTED: Fastest (default), OptimOptimal, SmallestSize, NoCompression

True to enable an optimization for self hosting. Creates one database per app and one collection per schema. Slows down inserts, but you can create custom indexes.

False to not use transactions. Improves performance. Warning: Can cause consistency issues.

The path to the dotnet-dump tool binary. REMARKS: Will be set automatically in the official Docker image.

When more memory is allocated that the defined value (in MB) a dump will be created once automatically and written to the asset store.

The path to the dotnet-gcdump tool binary. REMARKS: Will be set automatically in the official Docker image.

When more memory is allocated than the defined value (in MB) a gcdump will be created once automatically and written to the asset store.

The maximum number of megabyte that the process can consume until it is marked as not healthy.

The email body when an existing user is added as contributor to a team.

The email subject when an existing user is added as contributor to a team.

The email body when an existing user is added as contributor to an app.

The email subject when an existing user is added as contributor to an app.

The email body when a new user is added as contributor to an app.

The email subject when a new user is added as contributor to an app.

The email body when a new user is added as contributor to a team.

The email subject when a new user is added as contributor to a team.

The password to authenticate to your email server.

The username to authenticate to your email server

Squidex Configuration - Environment Variables

A list of configuration values that should be exposed from the info endpoint and in the UI.

The api key. See link https://docs.microsoft.com/en-us/azure/search/search-create-service-portal#get-a-key-and-url-endpoint.

The URL to your azure search instance. Read More: https://docs.microsoft.com/en-us/azure/search/search-create-service-portal#get-a-key-and-url-endpoint

The configuration to your elastic search cluster. Read More: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-configuration.html

Define the type of the full text store. SUPPORTED: elastic (ElasticSearch), azure (Azure Cognitive Search), default. Default: default

Defines how long the graphl schema is cached. Default: 10 min.

The batch size of the data loader. HINT: Can be overriden with the X-BatchSize header up to a maximum of 5000.

The apps which should be visible on the dashboard for the admin.

The email address of the admin user. You can also set the admin email with the initial setup screen.

The password of the admin user (Must contain lowercase, uppercase letter, number and special character). You can also set the admin password with the initial setup screen.

Recreate the admin if it does not exist or the password does not match.

Enable custom domains and oidc settings for teams.

Enable password auth. Set this to false if you want to disable local login, leaving only 3rd party login options.

Lock new users automatically, the administrator must unlock them.

When oidcDisableProfileScope is set to true scope "profile" will be removed.

Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions by default contains scopes "openid" and "profile".

The url to you privacy statements, if you host squidex by yourself.

Set to true to show PII (Personally Identifiable Information) in the logs.

Specifies whether to suppress the generation of X-Frame-Options header which is used to prevent ClickJacking.

Use custom languages where the key is the language code and the value is the english name.

============================================

True, to enable application insights integraon.

Setting the flag to true, enables well formatteds json logs.

The log level of the implementation adapter. Trace, Debug, Information, Warning, Error, Fatal

The log level of the default log adapter.

Only logs issued tokens and general request information.

Set to false to disable logging of http requests.

True, to enable OpenTelemetry Protocol integration.

The sample rate as double. 0.5 writes every second trace.

The number of days request log items will be stored.

Use this flag to set Squidex to readonly, e.g. when you deploy a second instance for migration.

The ID of the app in notifo. Configure notifo if you want to have support for custom notifications.

Set to true to create dummy asset files if they do not exist. Useful when a backup fail.

How often the rule jobs are queried for updated. Must be greater than zero.

True to delete schemas and the content permanently. This process can take a while and is executed in the background.

The timeout for the whole script execution.

The timeout for the asynchronous promise of the script.

The timeout for the synchronous part of the script.

Set to empty to disable authentication with third party providers.

Defines the number of collections for assets.

True, if you want to enable mongo atlas for full text search instead of MongoDB.

The database for all your content collections (one collection per app).

Defines the number of collections for contents.

The database for all your other read collections.

Defines the number of collections for texts.

Defines how key-value-store values are represented in MongoDB (e.g. app, rule, schema). SUPPORTED: Document, String, Binary (from slow to fast).

The database provider. SUPPORTED: MySql, Postgres, SqlServer

The version of the MySQL server. For MySQL - Ensure that: Version is set correctly, Server is initialized with --log-bin-trust-function-creators=1, Server is initialized with --local-infile=1 (for bulk inserts), Connection String has: AllowLoadLocalInfile=true

Define the type of the read store. SUPPORTED: MongoDb, Sql

The deepl api key if you want to support automated translations.

The google cloud project id if you want to support automated translations.

Hide all onboarding tooltips and dialogs.

The optional google maps API key. CREATE YOUR OWN PLEASE.

Define the type of the geolocation service. SUPPORTED: GoogleMaps, OSM

With your setup, only admins can create new apps. If you want to change this set false

With your setup, only admins can create new teams. If you want to change this set false

The number of content items for dropdown selector.

$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$ # Regex for emails.

%[\\]@!\\$&'\$\$\\*\\+,;=.]+$ # Regex for urls.

Show the exposed values as information on the apps overview page.

The base path when running Squidex behind a reverse proxy like nginx under a subfolder / subpath.

The base URL under which Squidex is running. It is used to generate hyperlinks and to make redirects with the correct host name. In some environments, Squidex is running behind several proxies, e.g. cloudflare, google load balancer and so on. In these cases the original host name might get lost. Therefore we introduced this configuration value.

Set it to true to use the X-Forwarded- headers for host name and scheme.

Set it to true to return a 400 if the host does not match.

Set it to true to redirect the user from http to https permanently.

A list of known proxies to make forward headers safer.

resizer

mongo

Root user password, set during initialization.

User created during initialization, given the root role.

Public URL to connect to MongoDB, used for Data panel.

Deploy and Host Squidex HeadlessCMS on Railway

What is Squidex HeadlessCMS?

About Hosting Squidex HeadlessCMS

Common Use Cases

Dependencies for Squidex HeadlessCMS Hosting

Deployment Dependencies

Implementation Details (Optional)

Feedback on Environment Variables

Why Deploy Squidex HeadlessCMS on Railway?