Add more instructions for applying ORM migrations for S3 deployment

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#524 11 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 4 ngày

@ShryukGrandhi đang làm issue này rồi.

Từ ngày 31/10/2026.

  • #1011 của @ShryukGrandhi — đang mở

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
aws, python
Lĩnh vực
cloud, database, documentation

Hướng nghiên cứu

Cập nhật burr/tracking/server/s3/README.md bằng cách sử dụng user script được cung cấp làm tài liệu tham chiếu cho việc thiết lập lần đầu. Ghi lại việc tạo thư mục migration, chạy aerich init với burr.tracking.server.s3.settings.TORTOISE_ORM, chạy aerich init-db, sau đó khởi động Burr với backend S3; công việc được xem là hoàn thành khi README giải thích đầy đủ việc thiết lập cơ sở dữ liệu ban đầu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

area/storage area/ui help wanted kind/documentation priority/low

Is your feature request related to a problem? Please describe.
The README does not contain the steps to properly set up the DB the first time.

Describe the solution you'd like
We should mention what to do -- we can use the script below for those instructions.

Describe alternatives you've considered
N/A

Additional context
User script that works:

#!/bin/sh

# Echo commands for debugging
set -x

# Signal handling:
trap 'echo "Caught signal, continuing anyway"' INT TERM

echo "Starting script execution"

# Create the directory structure if it doesn't exist
mkdir -p /root/.burr_server
echo "Created directory structure at /root/.burr_server"

# Initialize and apply migrations in the correct path
cd /app

echo "Running aerich init..."
aerich init -t burr.tracking.server.s3.settings.TORTOISE_ORM --location /root/.burr_server/migrations || echo "Aerich init failed or already initialized"

# Run aerich init-db with a timeout to prevent hanging
echo "Running aerich init-db..."
# Use timeout command to ensure we don't hang indefinitely
# aerich init-db will not exit or allow this script to continue without a timeout
timeout 10s aerich init-db > /tmp/aerich.log 2>&1 || echo "aerich init-db timed out or exited with non-zero status"
echo "aerich init-db result:"
cat /tmp/aerich.log

echo "Finished migration steps"

# Print database location information
echo "Database directory contents:"
ls -la /root/.burr_server/
echo "Database file exists check:"
test -f /root/.burr_server/db.sqlite3 && echo "Database file exists" || echo "Database file DOES NOT exist"

# Start the Burr server with verbose output
echo "Starting Burr server with --host 0.0.0.0 --backend s3"
burr --host 0.0.0.0 --backend s3
Ngôn ngữ chính
Python
Star
2.6k
Fork
212
Merge trung bình
5 ngày 14 giờ
Pull request đã merge (30 ngày)
26

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của apache/burr

Tất cả issue của apache/burr

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.