GEOFlow

https://github.com/yaojingang/geoflow
Admin
GEOFlow is an open-source GEO operations platform for enterprise websites, integrating trusted...
Tokens:558,433
Snippets:3,286
Trust Score:7.9
License:AGPL-3.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Task Management Commands

Source: https://github.com/yaojingang/geoflow/blob/main/docs/GEOFLOW_CLI_en.md

Examples for creating, starting, and monitoring tasks and jobs using the CLI.

```bash
bin/geoflow --config /path/to/profile.json task create \
  --json ./task.json \
  --idempotency-key task-create-001

bin/geoflow --config /path/to/profile.json task start 12 \
  --enqueue-now \
  --idempotency-key task-start-12

bin/geoflow --config /path/to/profile.json task jobs 12 --limit 20
bin/geoflow --config /path/to/profile.json job get 88
```

--------------------------------

### Install Application for Traditional Deployment

Source: https://github.com/yaojingang/geoflow/wiki/Deployment-Guide

Steps to clone the repository and install production dependencies.

```bash
git clone https://github.com/yaojingang/GEOFlow.git
cd GEOFlow
composer install --no-dev --optimize-autoloader
cp .env.prod.example .env
```

--------------------------------

### Execute Initial Installation Command

Source: https://github.com/yaojingang/geoflow/blob/main/docs/deployment/DEPLOYMENT.md

Run this command after migration if the init service is not used to perform the first-time installation and create the default administrator.

```bash
docker compose --env-file .env.prod -f docker-compose.prod.yml run --rm app php artisan geoflow:install
```

--------------------------------

### Install Basic System Tools

Source: https://github.com/yaojingang/geoflow/wiki/Deployment-Guide

Commands to install essential dependencies on Ubuntu or Debian systems.

```bash
sudo apt update
sudo apt install -y git curl ca-certificates
```

--------------------------------

### Fresh Installation Command

Source: https://github.com/yaojingang/geoflow/blob/main/docs/deployment/DEPLOYMENT.md

Single command for fresh, empty database installations. Do not use for existing data upgrades.

```bash
docker compose --env-file .env.prod -f docker-compose.prod.yml up -d --remove-orphans --build
```

--------------------------------

### Start Local Development Server

Source: https://github.com/yaojingang/geoflow/blob/main/public/previews/geoflow-admin-ui-v2/README.md

Use the PHP built-in server to host the prototype locally from the project root.

```bash
php -S 127.0.0.1:4173 -t public
```

--------------------------------

### Execute Updater Installation Script

Source: https://github.com/yaojingang/geoflow/blob/main/docs/deployment/GEOFLOW_V3_UPGRADE.md

Runs the installation script from the extracted package and verifies the installed version.

```bash
sudo "$updater_dir/packaging/scripts/install.sh"
sudo geoflow-updater version
```

--------------------------------

### Initial Deployment Commands

Source: https://github.com/yaojingang/geoflow/wiki/Deployment-Guide

Commands to build and start the production services.

```bash
$COMPOSE_PROD build
$COMPOSE_PROD up -d postgres redis
$COMPOSE_PROD up -d init
$COMPOSE_PROD up -d app web queue scheduler reverb
```

--------------------------------

### Install and verify GEOFlow CLI

Source: https://github.com/yaojingang/geoflow/blob/main/docs/GEOFLOW_CLI_en.md

Clone the repository, install dependencies via Composer, and verify the installation using the version and help commands.

```bash
git clone https://github.com/yaojingang/GEOFlow.git
cd GEOFlow
composer install --no-interaction --prefer-dist

bin/geoflow --version
bin/geoflow --help
```

--------------------------------

### Install Composer dependencies

Source: https://github.com/yaojingang/geoflow/blob/main/docs/GEOFLOW_CLI_en.md

Install dependencies for the checked-out code version.

```bash
composer install --no-interaction --prefer-dist
```

--------------------------------

### Initialize Production Application

Source: https://github.com/yaojingang/geoflow/wiki/Deployment-Guide

Commands to generate keys, run migrations, seed the database, and optimize the application.

```bash
php artisan key:generate
php artisan migrate --force
php artisan db:seed --force
php artisan storage:link
php artisan optimize
```

--------------------------------

### Example State URL

Source: https://github.com/yaojingang/geoflow/blob/main/public/previews/geoflow-admin-ui-v2/README.md

An example of applying a state parameter to a specific page.

```text
pages/content/tasks-index.html?state=empty
```

--------------------------------

### Start Optional Reverb Server

Source: https://github.com/yaojingang/geoflow/wiki/Deployment-Guide

Command to start the Reverb WebSocket server.

```bash
php artisan reverb:start --host=0.0.0.0 --port=8080
```

--------------------------------

### Initialize configuration

Source: https://github.com/yaojingang/geoflow/blob/main/docs/GEOFLOW_CLI.md

Initialize the default configuration file interactively with a base URL.

```bash
bin/geoflow config init --base-url https://geoflow.example.com
```

--------------------------------

### Initialize Development Environment

Source: https://github.com/yaojingang/geoflow/blob/main/README.md

Commands to install dependencies, build assets, run tests, and perform code quality checks.

```bash
composer install
npm ci
npm run build
composer test
npm run test:analytics
vendor/bin/pint --test
```
Tokens:
Raw