Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abdealijaroli authored Sep 2, 2024
1 parent bd389bb commit 4a1f488
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,20 @@ The application inside this container reads its configuration from a single envi
### Required Environment Variable
- **DB_URL**: PostgreSQL connection string (e.g., `postgresql://user:password@host:port/dbname`)

## Run
## 1. Run the server
To run the Jaro application, use the following command, replacing the `DB_URL` with your actual PostgreSQL connection string:
```
docker run -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest
docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest
```

## 2. Shorten a link
```
docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest -s https://example.com
```

## 3. Transfer a file
```
docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest -t /path/to/your/file
```

## Features
Expand All @@ -29,4 +39,4 @@ docker run -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 ab
If you would like to contribute to Jaro, feel free to submit a pull request or open an issue.

## License
This project is open-source and available under the [MIT License](LICENSE).
This project is open-source and available under the [MIT License](LICENSE).

0 comments on commit 4a1f488

Please sign in to comment.