mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-02-13 21:05:19 +00:00
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced a CLI command to manage local Certificate Authority (CA) and generate SSL certificates for development domains. - Added example and template files for Nginx and OpenSSL configurations to support local development with SSL. - Provided new DNS and Nginx configuration files for enhanced local development setup. - **Documentation** - Added a README with step-by-step instructions for setting up development containers and managing certificates on MacOS with OrbStack. - **Chores** - Updated ignore patterns to exclude additional development files and directories. - Enhanced example Docker Compose files with commented service configurations and new volume definitions. - Removed the Elasticsearch example Docker Compose file. - **Refactor** - Extended utility and command classes with new methods to support file operations and command execution. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
28 lines
525 B
Markdown
28 lines
525 B
Markdown
# Dev containers
|
|
|
|
## Develop with domain
|
|
|
|
> MacOs only, OrbStack only
|
|
|
|
### 1. Generate and install Root CA
|
|
|
|
```bash
|
|
# the root ca file will be located at `./.docker/dev/certs/ca`
|
|
yarn affine cert --install
|
|
```
|
|
|
|
### 2. Generate domain certs
|
|
|
|
```bash
|
|
# certificates will be located at `./.docker/dev/certs/${domain}`
|
|
yarn affine cert --domain dev.affine.fail
|
|
```
|
|
|
|
### 3. Enable dns and nginx service in compose.yml
|
|
|
|
### 4. Add custom dns server
|
|
|
|
```bash
|
|
echo "nameserver 127.0.0.1" | sudo tee /etc/resolver/dev.affine.fail
|
|
```
|