django-railway-storage
A Django package that provides Railway bucket storage backends and a management command to auto-configure your settings.
Installation
pip install django-railway-storage
Add to INSTALLED_APPS:
INSTALLED_APPS = [
...
'django_railway_storage',
]
Setting up a Railway Bucket
- On the Railway canvas, right-click an empty area and select Add Service
- Select Bucket from the list
- Click Deploy to provision the bucket
- Navigate to the Credentials tab of the bucket
- Click Add to Service
- Select the service (your Django app) you want to connect the bucket to
- Under Style, select either:
- AWS SDK (Generic) — for general S3-compatible access
- Django (django-storages) — injects variables matching
django-storagesnaming
- The injected environment variables will match what this package expects:
AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEYAWS_STORAGE_BUCKET_NAMEAWS_S3_ENDPOINT_URLAWS_S3_REGION_NAME
- Click Add Service to save — the variables are now available in your Railway deployment
Usage
Auto-configure settings
Run the management command to append the storage config to your settings file:
# Private storage (presigned URLs, default)
python manage.py configure_railway_storage
# Public storage
python manage.py configure_railway_storage --storage public
# Custom settings file path
python manage.py configure_railway_storage --settings-file config/settings/production.py
# Custom presigned URL expiry (seconds)
python manage.py configure_railway_storage --storage private --expire 7200
Required environment variables
Railway injects these automatically when you connect a bucket to your service. Both naming styles are supported:
| Railway Variable | Alternative | Description |
|---|---|---|
AWS_ACCESS_KEY_ID |
— | Railway bucket access key |
AWS_SECRET_ACCESS_KEY |
— | Railway bucket secret key |
AWS_S3_BUCKET_NAME |
AWS_STORAGE_BUCKET_NAME |
Bucket name |
AWS_ENDPOINT_URL |
AWS_S3_ENDPOINT_URL |
Railway S3-compatible endpoint URL |
AWS_DEFAULT_REGION |
AWS_S3_REGION_NAME |
Region (default: us-east-1) |
Use backends directly
You can also reference the backends manually in your settings:
# Private (presigned URLs)
STORAGES = {
"default": {
"BACKEND": "django_railway_storage.backends.PrivateMediaStorage",
},
...
}
# Public
STORAGES = {
"default": {
"BACKEND": "django_railway_storage.backends.PublicMediaStorage",
},
...
}
Use on a model field
from django.db import models
class Document(models.Model):
file = models.FileField(upload_to='documents/') # uses default storage
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_railway_storage-1.0.5.tar.gz.
File metadata
- Download URL: django_railway_storage-1.0.5.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96a1ac0104f75b65827219ac7ad68824053efbf23219d6e7f3ea86905a0c1b81
|
|
| MD5 |
c3256b0a5e1500331d056a44edf26b36
|
|
| BLAKE2b-256 |
9a5e64f88b12ff32ae9520ae65d4f290b72957608a664cba13b6b5206236b4d0
|
Provenance
The following attestation bundles were made for django_railway_storage-1.0.5.tar.gz:
Publisher:
ci.yml on Franklinson/Railway-Storage
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
django_railway_storage-1.0.5.tar.gz -
Subject digest:
96a1ac0104f75b65827219ac7ad68824053efbf23219d6e7f3ea86905a0c1b81 - Sigstore transparency entry: 2464000500
- Sigstore integration time:
-
Permalink:
Franklinson/Railway-Storage@13dba9e65b3d6eea8b001b81ea4eb8597ae9c3b0 -
Branch / Tag:
refs/tags/v1.0.5 - Owner: https://github.com/Franklinson
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@13dba9e65b3d6eea8b001b81ea4eb8597ae9c3b0 -
Trigger Event:
push
-
Statement type:
File details
Details for the file django_railway_storage-1.0.5-py3-none-any.whl.
File metadata
- Download URL: django_railway_storage-1.0.5-py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
deee8165aa4ca3e3444c83f79b52d26db164c12493cad10adc72336d9eb36a44
|
|
| MD5 |
89f7a53529ded2f1acd0ad105532da4e
|
|
| BLAKE2b-256 |
a59205eb35092955566ac229d9c1940dfdc94310d4aa95b7d3f2dbd1d5bc8cb0
|
Provenance
The following attestation bundles were made for django_railway_storage-1.0.5-py3-none-any.whl:
Publisher:
ci.yml on Franklinson/Railway-Storage
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
django_railway_storage-1.0.5-py3-none-any.whl -
Subject digest:
deee8165aa4ca3e3444c83f79b52d26db164c12493cad10adc72336d9eb36a44 - Sigstore transparency entry: 2464000786
- Sigstore integration time:
-
Permalink:
Franklinson/Railway-Storage@13dba9e65b3d6eea8b001b81ea4eb8597ae9c3b0 -
Branch / Tag:
refs/tags/v1.0.5 - Owner: https://github.com/Franklinson
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@13dba9e65b3d6eea8b001b81ea4eb8597ae9c3b0 -
Trigger Event:
push
-
Statement type:
