Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mayoreee/thumbor_dash
A Thumbor server extension for DASH
https://github.com/mayoreee/thumbor_dash
Last synced: 3 months ago
JSON representation
A Thumbor server extension for DASH
- Host: GitHub
- URL: https://github.com/mayoreee/thumbor_dash
- Owner: mayoreee
- License: mit
- Created: 2021-05-12T21:47:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-12T02:43:19.000Z (over 2 years ago)
- Last Synced: 2024-04-26T02:21:02.855Z (9 months ago)
- Language: Python
- Homepage:
- Size: 206 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-thumbor - GitHub
README
# thumbor_dash
A thumbor server extension for DASH
## Setup
#### Requirements
- Python <= 3.11
- Thumbor == 7.7.4
See the requirements for setting up `thumbor` in the [documentation](https://thumbor.readthedocs.io/en/latest/installing.html)
#### 1. Install thumbor_dash
```
git clone https://github.com/mayoreee/thumbor_dash.git && cd thumbor_dash
```
```
python3 -m pip install .
```
Note: thumbor_dash, thumbor, and other required dependencies will be installed
#### 2. Create a thumbor configuration file
`thumbor-config > thumbor.conf`
#### 3. Add these lines to `thumbor.conf` file
```python
# Set allowed dimensions
MIN_WIDTH = 1
MIN_HEIGHT = 1
MAX_WIDTH = 1200
MAX_HEIGHT = 800
# Use custom Url signing method (sha256)
URL_SIGNER = 'thumbor_dash.url_signers.base64_hmac_sha256'
# Allow only signed URL
ALLOW_UNSAFE_URL = False
# Set user moderation rules
REQUEST_TIME_LIMIT = 1 # time between requests in minutes
USAGE_VIOLATION_LIMIT = 5 # total number of times a requester can violate the time limit before ban
BAN_DURATION = 10 # requester ban duration in minutes
# Use custom error handling
USE_CUSTOM_ERROR_HANDLING = True
ERROR_HANDLER_MODULE = 'thumbor_dash.error_handlers.sentry'
# User-defined MN and IP list
SEED_IP = 'seed-1.testnet.networks.dash.org'
MN_LIST = '35.165.50.126,52.10.229.11,54.149.33.167,52.24.124.162,54.187.14.232'
```
## Usage
#### 1. Start thumbor_dash server
`thumbor_dash --conf=thumbor.conf`
#### 2. Sign image URL
```python
thumbor_dash-url --key="" --width= --height= --dashauth="requester():contract():document(thumbnail):field(avatarUrl):owner():updatedAt()" --filters=""
```
`output:`
```python
//x/dashauth:requester():contract():document(thumbnail):field(avatarUrl):owner():updatedAt()/filters:format()/
```
#### 3. Thumbor_dash image retrieval URL
```python
http:////x/dashauth:requester():contract():document(thumbnail):field(avatarUrl):owner():updatedAt()/filters:format()/
```
## Example
This is a signed `thumbor_dash url`. Simply run `thumbor_dash` and paste this link in your browser.
```python
http://localhost:8888/wQ71tyl2OvFRVvHkrEWnbZp4dxE1E0fhaLcqbYgp8Uw=/1200x800/dashauth:requester(CbmEawiuxwJZPp3aJJkuM8Pw5CnMAkQvaQmTouLHcH2Q):contract(CubPbDcDPCi3HhbSNRQfkZDYU6R2yPsPveHrWoCKJr1P):document(thumbnail):field(avatarUrl):owner(CbmEawiuxwJZPp3aJJkuM8Pw5CnMAkQvaQmTouLHcH2Q):updatedAt(1727625029657)/filters:format(jpeg)/https%3A//raw.githubusercontent.com/thumbor/thumbor/master/example.jpg
```
# Running thumbor_dash in Docker
This is the fastest way to run `thumbor_dash`
#### 1. Create a `thumbor.env.txt` file containing the environment variables
```python
MIN_WIDTH=1
MIN_HEIGHT=1
MAX_WIDTH=1200
MAX_HEIGHT=800
REQUEST_TIME_LIMIT=1
USAGE_VIOLATION_LIMIT=5
BAN_DURATION=10
USE_CUSTOM_ERROR_HANDLING=True
ALLOW_UNSAFE_URL=False
URL_SIGNER=thumbor_dash.url_signers.base64_hmac_sha256
ERROR_HANDLER_MODULE=thumbor_dash.error_handlers.sentry
SEED_IP=seed-1.testnet.networks.dash.org
MN_LIST=35.165.50.126,52.10.229.11,54.149.33.167,52.24.124.162,54.187.14.232
```
#### 2. Start thumbor_dash server in Docker
`docker run -p 8888:8888 --env-file thumbor.env.txt mayoreee/thumbor_dash`