Answers to get started
Questions aboutDwell.
What to know before your first project: requirements, workflow and limits. These answers relate to the current repository state.
12 matching questions
Getting started and requirements
What does Dwell handle for me?
Dwell organizes local Docker services, domains and gateway routing through a project configuration. You control the environment through the CLI. Your editor, framework, application logic and debugging remain part of your own workflow.
What do I need to install Dwell?
Node.js 20.19.0 or later, npm in your PATH, and Docker Desktop or another running Docker daemon. Dwell requires a working local Docker environment.
Has Dwell been published on npm?
No. The README currently describes Dwell as an unpublished pre-beta release candidate. Build the package from a repository checkout and install the generated file. The installation section contains the commands.
Can I use Dwell commercially?
Dwell is covered by the GPLv3 licence, which permits commercial use (e.g. building client projects). However, if you modify and distribute the Dwell source code, you must release your changes under the same conditions (Copyleft). Check the licence file for your version and the licences of its dependencies.
Projects and workflow
How do I start my first project?
Run dwell init for interactive setup. Then build services with dwell build and start the environment with dwell up. The README also provides examples of non-interactive configurations.
Where are configuration and runtime files stored?
The project configuration is in .dwell/dwell.json. Generated runtime files live in .dwell/runtime/. The shared gateway uses ~/.dwell/gateway/. Consult the documentation for your version before making changes.
Can I use Dwell without Docker?
No. Docker is the foundation of the local environment. If you cannot or do not want to use containers, you need another approach.
Can I use Dwell in production?
Dwell is intended for local development. Securely running publicly accessible applications, deployment and production infrastructure are separate responsibilities.
Domains, HTTPS and networking
Which local domain does my project use?
The local address uses .localhost. Project name, runtime slug and host base can be configured independently. Matching .local names are added when LAN sharing is enabled.
Why must my browser trust the local certificate?
The gateway provides local HTTPS connections. Your browser needs to trust the local certificates in use. Do not simply bypass certificate warnings; check the setup and documentation for your system.
How do I access my project from a phone?
Enable local sharing with dwell up --lan. The other device needs to be on the appropriate local network and resolve the .local name. Availability depends on the network and mDNS support; sharing is not an internet tunnel.
What should I check if a project does not start?
First check that Docker is running and requirements are met. dwell doctor supports diagnostics, dwell ps shows state and dwell logs shows output. Also check the project configuration and documentation for your version.
Still have a question?
Ask directly.
Describe your setup, Dwell version and specific question. Please do not send credentials or other confidential information.
