update markdown files
This commit is contained in:
32
README.md
32
README.md
@@ -36,6 +36,7 @@ From your projects directory, run:
|
||||
./sync-project.sh -h # Show help manual
|
||||
./sync-project.sh --files-only # Quick sync (files only, no scripts)
|
||||
./sync-project.sh --sftp-only # SFTP setup (no lazygit, no .gitignore updates)
|
||||
./sync-project.sh --git # Full project setup via git clone
|
||||
```
|
||||
|
||||
## What the Script Does
|
||||
@@ -160,6 +161,34 @@ Full setup with all features:
|
||||
- Uploads lazygit to server
|
||||
- Updates `.gitignore`
|
||||
|
||||
### `--git` Mode
|
||||
Full project setup via git clone with comprehensive environment configuration:
|
||||
|
||||
**What it does (12 steps):**
|
||||
1. **Clone repository** via git over SSH, check for `.npmrc`
|
||||
2. **Copy Docker env** from `.docker/config/.env.local` to `.env`
|
||||
3. **Clean Docker** - stop/remove all containers and volumes
|
||||
4. **Run docker-setup.sh** if present
|
||||
5. **Copy server .env** to `.server.env` (marked assume-unchanged)
|
||||
6. **Modify local .env** - extract APP_NAME and APP_KEY from server
|
||||
7. **Create .env.prod.local** with production database credentials
|
||||
8. **Add helper scripts** - generates `ssh.sh` with embedded credentials
|
||||
9. **Upload lazygit** to server (marked assume-unchanged)
|
||||
10. **SSH key management** - generates or downloads `staging.key`
|
||||
11. **SSH-add** - adds staging.key to SSH agent
|
||||
12. **Database setup** - runs `db:wipe` and `make db-sync`
|
||||
|
||||
**Generated files:**
|
||||
- `ssh.sh` - SSH helper script (added to .gitignore)
|
||||
- `staging.key` - SSH private key for server access (added to .gitignore)
|
||||
- `.server.env` - Copy of server's .env file
|
||||
- `.env.prod.local` - Production credentials for database sync
|
||||
|
||||
**Use cases:**
|
||||
- Setting up a new development environment from scratch
|
||||
- Cloning a project with full Docker and database configuration
|
||||
- Projects that use git for version control on the server
|
||||
|
||||
### `--files-only` Mode
|
||||
Quick sync for when you just need the files:
|
||||
- Downloads project files (excludes `node_modules`, `vendor`)
|
||||
@@ -182,6 +211,9 @@ Lightweight setup for SFTP workflows:
|
||||
- **sshpass** - Password authentication
|
||||
- **tar** - Archive creation
|
||||
- **rsync** - File synchronization
|
||||
- **git** - For `--git` mode
|
||||
- **docker** - For `--git` mode
|
||||
- **make** - For `--git` mode database sync
|
||||
- **watchexec** (optional) - For watch mode scripts
|
||||
|
||||
### Install on macOS:
|
||||
|
||||
Reference in New Issue
Block a user