Update Docker Documentation to Address Line Ending Issues for Windows Users
- Added a warning for Windows users regarding the importance of maintaining LF (Unix-style) line endings in script files to prevent Docker containers from hanging during startup. - Included instructions for configuring Git to preserve line endings and fixing the artisan script using dos2unix or sed commands. - Added a note about potential line ending issues that may arise when using Git or code editors on Windows, emphasizing the need for LF line endings in the `artisan` script. These changes aim to improve the documentation clarity and assist users in resolving common issues related to line endings when deploying with Docker.
This commit is contained in:
Julien Nahum
parent
5f0140c6df
commit
d2b8572d75
|
|
@ -19,6 +19,19 @@ Looking to develop OpnForm locally? Check out our [Docker Development Setup](/de
|
||||||
cd OpnForm
|
cd OpnForm
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<Warning>
|
||||||
|
**Important for Windows Users**: Ensure script files maintain LF (Unix-style) line endings. If you're using Windows, configure Git to preserve line endings:
|
||||||
|
```bash
|
||||||
|
git config core.autocrlf false
|
||||||
|
```
|
||||||
|
And check/fix the artisan script before running setup:
|
||||||
|
```bash
|
||||||
|
# Using Git Bash or WSL
|
||||||
|
dos2unix api/artisan
|
||||||
|
```
|
||||||
|
Otherwise, Docker containers may hang at "Waiting for DB to be ready" during startup.
|
||||||
|
</Warning>
|
||||||
|
|
||||||
2. Run the setup script:
|
2. Run the setup script:
|
||||||
```bash
|
```bash
|
||||||
chmod +x scripts/docker-setup.sh
|
chmod +x scripts/docker-setup.sh
|
||||||
|
|
@ -195,6 +208,22 @@ docker compose exec db pg_isready
|
||||||
docker compose logs db
|
docker compose logs db
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If the API container is stuck on "Waiting for DB to be ready":
|
||||||
|
```bash
|
||||||
|
# Check for line ending issues in the artisan script
|
||||||
|
# The file should use LF (Unix) line endings, not CRLF (Windows)
|
||||||
|
|
||||||
|
# Fix line endings on Unix/Mac:
|
||||||
|
sed -i 's/\r$//' api/artisan
|
||||||
|
|
||||||
|
# Fix line endings on Windows (using Git Bash or WSL):
|
||||||
|
dos2unix api/artisan
|
||||||
|
```
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
**Line Ending Issue**: When using Git or code editors on Windows, line endings in the `artisan` script may be converted from LF (Unix-style) to CRLF (Windows-style). This prevents the Docker container from properly executing the script, causing it to hang at "Waiting for DB to be ready". Always ensure script files maintain LF line endings.
|
||||||
|
</Note>
|
||||||
|
|
||||||
### Cache Issues
|
### Cache Issues
|
||||||
|
|
||||||
Clear various caches:
|
Clear various caches:
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,165 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Script to generate tax exports for each month of 2024 in parallel
|
||||||
|
|
||||||
|
# Default number of concurrent processes
|
||||||
|
MAX_CONCURRENT=4
|
||||||
|
|
||||||
|
# Process command line arguments
|
||||||
|
while getopts "c:" opt; do
|
||||||
|
case $opt in
|
||||||
|
c) MAX_CONCURRENT=$OPTARG ;;
|
||||||
|
*) echo "Usage: $0 [-c max_concurrent_processes]" >&2
|
||||||
|
exit 1 ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
# Ensure valid concurrent processes value
|
||||||
|
if ! [[ "$MAX_CONCURRENT" =~ ^[1-9][0-9]*$ ]]; then
|
||||||
|
echo "Error: Invalid number of concurrent processes: $MAX_CONCURRENT"
|
||||||
|
echo "Please provide a positive integer."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Function to log messages with timestamp
|
||||||
|
log() {
|
||||||
|
echo "[$(date +'%Y-%m-%d %H:%M:%S')] $1"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ensure we're in the Laravel API directory
|
||||||
|
cd api || { log "Error: API directory not found"; exit 1; }
|
||||||
|
|
||||||
|
log "Starting tax export generation for all months of 2024 (max $MAX_CONCURRENT concurrent processes)"
|
||||||
|
|
||||||
|
# Create a directory for the logs
|
||||||
|
mkdir -p tax_export_logs
|
||||||
|
|
||||||
|
# Create a temporary directory for status files
|
||||||
|
tmp_dir=$(mktemp -d)
|
||||||
|
trap 'rm -rf "$tmp_dir"' EXIT
|
||||||
|
|
||||||
|
# Function to run export for a specific month
|
||||||
|
run_export() {
|
||||||
|
month=$1
|
||||||
|
month_num=$(printf "%02d" $month)
|
||||||
|
year=2024
|
||||||
|
|
||||||
|
# Calculate start and end dates for the month
|
||||||
|
start_date="${year}-${month_num}-01"
|
||||||
|
|
||||||
|
# Determine the end date based on the month
|
||||||
|
case $month in
|
||||||
|
2) # February (considering leap year 2024)
|
||||||
|
end_date="${year}-${month_num}-29"
|
||||||
|
;;
|
||||||
|
4|6|9|11) # April, June, September, November
|
||||||
|
end_date="${year}-${month_num}-30"
|
||||||
|
;;
|
||||||
|
*) # January, March, May, July, August, October, December
|
||||||
|
end_date="${year}-${month_num}-31"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
log_file="tax_export_logs/export-${year}-${month_num}.log"
|
||||||
|
status_file="${tmp_dir}/status_${month}.txt"
|
||||||
|
|
||||||
|
log "Starting tax export for ${year}-${month_num}..."
|
||||||
|
|
||||||
|
# Run the Laravel command for this month and log the output
|
||||||
|
{
|
||||||
|
echo "================ EXPORT START: $(date) ================"
|
||||||
|
php artisan stripe:generate-stripe-export --start-date=$start_date --end-date=$end_date
|
||||||
|
exit_code=$?
|
||||||
|
echo "================ EXPORT END: $(date) ================"
|
||||||
|
echo "Exit code: $exit_code"
|
||||||
|
|
||||||
|
if [ $exit_code -ne 0 ]; then
|
||||||
|
echo "ERROR: Export failed with exit code $exit_code"
|
||||||
|
else
|
||||||
|
echo "SUCCESS: Export completed successfully"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Write status to file for the parent process to read
|
||||||
|
echo "$exit_code" > "$status_file"
|
||||||
|
} > "$log_file" 2>&1
|
||||||
|
|
||||||
|
if [ $exit_code -ne 0 ]; then
|
||||||
|
log "ERROR: Export for ${year}-${month_num} failed with exit code $exit_code"
|
||||||
|
else
|
||||||
|
log "Successfully completed tax export for ${year}-${month_num}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Track running processes
|
||||||
|
pids=()
|
||||||
|
months=()
|
||||||
|
|
||||||
|
# Export each month with limited concurrency
|
||||||
|
for month in {1..12}; do
|
||||||
|
# Wait if we've reached the maximum number of concurrent processes
|
||||||
|
while [ ${#pids[@]} -ge $MAX_CONCURRENT ]; do
|
||||||
|
# Check if any processes have completed
|
||||||
|
for i in "${!pids[@]}"; do
|
||||||
|
if ! kill -0 ${pids[$i]} 2>/dev/null; then
|
||||||
|
# Process has completed, check its status
|
||||||
|
if [ -f "${tmp_dir}/status_${months[$i]}.txt" ]; then
|
||||||
|
status=$(cat "${tmp_dir}/status_${months[$i]}.txt")
|
||||||
|
if [ "$status" -ne 0 ]; then
|
||||||
|
log "Process for month ${months[$i]} completed with error: $status"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
# Remove from arrays
|
||||||
|
unset pids[$i]
|
||||||
|
unset months[$i]
|
||||||
|
# Reindex arrays
|
||||||
|
pids=("${pids[@]}")
|
||||||
|
months=("${months[@]}")
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
sleep 1
|
||||||
|
done
|
||||||
|
|
||||||
|
# Start the export process in the background
|
||||||
|
run_export $month &
|
||||||
|
pid=$!
|
||||||
|
pids+=($pid)
|
||||||
|
months+=($month)
|
||||||
|
|
||||||
|
log "Started export for month $month (PID: $pid)"
|
||||||
|
|
||||||
|
# Optional: Add a small delay to avoid overwhelming the system
|
||||||
|
sleep 0.5
|
||||||
|
done
|
||||||
|
|
||||||
|
# Wait for all background processes to complete
|
||||||
|
log "Waiting for all export processes to complete..."
|
||||||
|
wait
|
||||||
|
|
||||||
|
# Collect results
|
||||||
|
failed_months=()
|
||||||
|
for month in {1..12}; do
|
||||||
|
if [ -f "${tmp_dir}/status_${month}.txt" ]; then
|
||||||
|
status=$(cat "${tmp_dir}/status_${month}.txt")
|
||||||
|
if [ "$status" -ne 0 ]; then
|
||||||
|
failed_months+=($month)
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
# Status file missing - consider it a failure
|
||||||
|
log "WARNING: No status file found for month $month. Considering it failed."
|
||||||
|
failed_months+=($month)
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# Check if any months failed
|
||||||
|
if [ ${#failed_months[@]} -gt 0 ]; then
|
||||||
|
log "WARNING: Exports for the following months failed: ${failed_months[*]}"
|
||||||
|
log "Please check the corresponding log files for details."
|
||||||
|
exit_code=1
|
||||||
|
else
|
||||||
|
log "All tax exports completed successfully for 2024"
|
||||||
|
exit_code=0
|
||||||
|
fi
|
||||||
|
|
||||||
|
log "All exports have been processed. Check tax_export_logs/ directory for detailed logs."
|
||||||
|
exit $exit_code
|
||||||
Loading…
Reference in New Issue