Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Add more instructions for applying ORM migrations for S3 deployment

Abierto Apto para principiantes
  • ¿Algo no está bien?
#524 11 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 4 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
aws, python
Área
cloud, database, documentation

Línea de trabajo

Actualiza burr/tracking/server/s3/README.md usando el script de usuario proporcionado como referencia para la configuración inicial. Documenta la creación del directorio de migraciones, la ejecución de aerich init con burr.tracking.server.s3.settings.TORTOISE_ORM, la ejecución de aerich init-db y, después, el inicio de Burr con el backend S3; se considera terminado cuando el README explica la configuración completa de la base de datos inicial.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Python
Estrellas
2.6k
Forks
208
Merge medio
8 d 9 h
PR fusionados (30 d)
26

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apache/burr

Todos los issues de apache/burr

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.