If you are not at Dolphiq

dqx was written for one fleet and is used by partner teams working on projects from it. Almost everything on this site applies to you unchanged. This page is the part that does not.

What works with nothing set up

The installer	curl -fsSL https://dqx.dolphiq.nl/install.sh | bash is public, and so is dqx self-update
The container images	The dolphiq/php* images the examples use are public on Docker Hub. Nothing to log in to
*.local.dolphiq.eu	A public DNS record pointing at 127.0.0.1, for any subdomain, on any machine. You may use it for your own local development, and you can use .dqx instead with no DNS at all - see domains
Everything about the router, the config, the backends	Nothing in there is ours specifically

The one thing you have to set

A repository written as a bare name in a config resolves against repositoryBase, and its default is our own Bitbucket organisation:

sites:
  - repositories:
      - repository: harbor-books        # resolves against repositoryBase

On your machine, point that at yours, once:

dqx config machine repositoryBase git@github.com:your-org
dqx config machine                            # what is set, and what is a default

Or give a full URL in the config, which is taken exactly as written and needs no setting at all:

      - repository: git@github.com:your-org/harbor-books.git

Without either, dqx install on a config with bare names fails on access to a workspace you cannot see. dqx now names this setting when that happens, but it is cheaper to set it first.

It only bites on bare names

dqx init and dqx adopt write the resolved URL rather than the name, so a project created or adopted on your machine carries addresses that work everywhere. Bare names come from configs written by hand.

The domain suffix

domainSuffix defaults to local.dolphiq.eu. Set it per project to whatever you use:

domainSuffix: dqx                       # or your own wildcard domain

Domains, DNS and certificates explains the two families - a suffix like .dqx resolved on your own machine, or a wildcard record on a domain you own. Both work; the wildcard is what lets a colleague open the project with nothing installed.

What you will not be able to reach

A handful of things on this site are ours by nature:

• The private repositories the examples clone. The recipes and the config shapes are general; the code behind a bare name may not be yours to read.
• A notes: line telling somebody to fetch a credential from our password manager. Those are written per project by whoever wrote the config.
• The measurements. Numbers on this site come from our own fleet, which is why they are numbers and not adjectives. Your machine will differ; dqx memory and dqx doctor measure yours.

Reporting something

A bug, or a way dqx exposes a credential it should not: tell the Dolphiq team you work with, or raise it through whatever channel your engagement uses. What dqx stores describes what it touches and why.

Contributing

Pull requests are welcome, and Contributing is written for you as much as for us: the architecture, the code style, the tests and what a pull request carries. Releasing and deploying is ours and happens after the merge, so there is nothing about it you need to do.