You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): update setup instructions for Docker
Add detailed Docker setup guide as the recommended method
Update local Python setup as an alternative option
Improve overall README structure and clarity
Copy file name to clipboardExpand all lines: README.md
+45-28Lines changed: 45 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,49 @@ A simple web interface for running Flux models using the Replicate API. Use it t
8
8
- Saves your settings
9
9
- Shows generated images in a gallery
10
10
11
-
## Setup
11
+
## Recommended Setup: Docker
12
+
Docker is the recommended way to run this application. It ensures consistent environment across different systems.
13
+
14
+
### Prerequisites
15
+
- Docker and Docker Compose installed on your system
16
+
- Replicate API key
17
+
18
+
### Docker Compose Setup
19
+
1. Create a `docker-compose.yml` file with the following content:
20
+
```yaml
21
+
services:
22
+
replicate-flux-lora:
23
+
image: ghcr.io/rtuszik/replicate-flux-lora:latest
24
+
container_name: replicate-flux-lora
25
+
environment:
26
+
- REPLICATE_API_TOKEN=${REPLICATE_API_TOKEN}
27
+
ports:
28
+
- "8080:8080"
29
+
volumes:
30
+
- ${HOST_OUTPUT_DIR}:/app/output
31
+
restart: unless-stopped
32
+
```
33
+
34
+
2. Create a `.env` file in the same directory with the following content:
35
+
```
36
+
REPLICATE_API_TOKEN=your_api_key_here
37
+
HOST_OUTPUT_DIR=/path/to/your/output/directory
38
+
```
39
+
Replace `your_api_key_here` with your actual Replicate API key and `/path/to/your/output/directory` with the directory on your host machine where you want to save generated images.
40
+
41
+
### Running with Docker
42
+
1. Start the application:
43
+
```
44
+
docker-compose up -d
45
+
```
46
+
47
+
2. Open `http://localhost:8080` in your browser
48
+
49
+
3. Choose a model, set your options, enter a prompt, and generate images
50
+
51
+
## Alternative Setup: Local Python Environment
52
+
If you prefer to run the application without Docker, you can use a local Python environment.
0 commit comments