Skip to content
This repository has been archived by the owner on Nov 14, 2023. It is now read-only.

Commit

Permalink
feat: add instruction to configure minio locally
Browse files Browse the repository at this point in the history
  • Loading branch information
NishaSharma14 committed Mar 2, 2023
1 parent cd06e5c commit 3ed88a6
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/developer-guides/installation/mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,27 @@ Run the below command to publish all the jobs and start the worker for the backg
./vendor/bin/sail artisan horizon
```

* To configure file object storage, you should have [Minio](https://min.io/) instance already running in your local(for more details check your docker-compose file). For the first time you have to generate the Access Keys, create the buckets and configure that in your `.env` file.
* Open the Minio instance running in your [http://localhost:8900](http://localhost:8900/)
* Login with user - `sail` and password - `password`
* Go to Access Keys and create a new access key.
* Create the two buckets with Read Write Access as `nmrxiv` and `nmrxiv-public`
* Update Filesystem driver and the AWS Keys as below in the `.env` file. Make sure you point your `AWS_URL` to Minio API which is running in port 9000.

```bash
FILESYSTEM_DRIVER=minio
FILESYSTEM_DRIVER_PUBLIC=minio_public

AWS_ACCESS_KEY_ID=RjcSdMxMiiGYycQV
AWS_SECRET_ACCESS_KEY=jCq9hAvsW4lmMzLzdyuvmoX7dqBpSc7W
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=nmrxiv
AWS_ENDPOINT=http://localhost:9000/
AWS_URL=http://localhost:9000/
AWS_USE_PATH_STYLE_ENDPOINT=false
AWS_BUCKET_PUBLIC=nmrxiv-public
```

Once the application's Docker containers have been started, you can access the application in your web browser at [http://localhost](http://localhost). But first, you will be prompted to <b>Generate app key</b>. After pressing the generation button, the following message is shown on the screen: "The solution was executed successfully. Refresh now." After refreshing, you access the application.

:::caution Recommendation
Expand Down
22 changes: 22 additions & 0 deletions docs/developer-guides/installation/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The whole project is a package of below services and features.
* [Selenium](https://www.selenium.dev/documentation/)
* [Meilisearch](https://docs.meilisearch.com/)
* [MailHog](https://mailtrap.io/blog/mailhog-explained/)
* [Minio](https://min.io/)

#### Ubuntu 20.04

Expand Down Expand Up @@ -70,6 +71,27 @@ Run the below command to publish all the jobs and start the worker for the backg
./vendor/bin/sail artisan horizon
```

* To configure file object storage, you should have [Minio](https://min.io/) instance already running in your local(for more details check your docker-compose file). For the first time you have to generate the Access Keys, create the buckets and configure that in your `.env` file.
* Open the Minio instance running in your [http://localhost:8900](http://localhost:8900/)
* Login with user - `sail` and password - `password`
* Go to Access Keys and create a new access key.
* Create the two buckets with Read Write Access as `nmrxiv` and `nmrxiv-public`
* Update Filesystem driver and the AWS Keys as below in the `.env` file. Make sure you point your `AWS_URL` to Minio API which is running in port 9000.

```bash
FILESYSTEM_DRIVER=minio
FILESYSTEM_DRIVER_PUBLIC=minio_public

AWS_ACCESS_KEY_ID=RjcSdMxMiiGYycQV
AWS_SECRET_ACCESS_KEY=jCq9hAvsW4lmMzLzdyuvmoX7dqBpSc7W
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=nmrxiv
AWS_ENDPOINT=http://localhost:9000/
AWS_URL=http://localhost:9000/
AWS_USE_PATH_STYLE_ENDPOINT=false
AWS_BUCKET_PUBLIC=nmrxiv-public
```

Once the application's Docker containers have been started, you can access the application in your web browser at [http://localhost](http://localhost). But first, you will be prompted to <b>Generate app key</b>. After pressing the generation button, the following message is shown on the screen: "The solution was executed successfully. Refresh now." After refreshing, you access the application.

:::caution Recommendation
Expand Down
21 changes: 21 additions & 0 deletions docs/developer-guides/installation/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,27 @@ Run the below command to publish all the jobs and start the worker for the backg
./vendor/bin/sail artisan horizon
```

* To configure file object storage, you should have [Minio](https://min.io/) instance already running in your local(for more details check your docker-compose file). For the first time you have to generate the Access Keys, create the buckets and configure that in your `.env` file.
* Open the Minio instance running in your [http://localhost:8900](http://localhost:8900/)
* Login with user - `sail` and password - `password`
* Go to Access Keys and create a new access key.
* Create the two buckets with Read Write Access as `nmrxiv` and `nmrxiv-public`
* Update Filesystem driver and the AWS Keys as below in the `.env` file. Make sure you point your `AWS_URL` to Minio API which is running in port 9000.

```bash
FILESYSTEM_DRIVER=minio
FILESYSTEM_DRIVER_PUBLIC=minio_public

AWS_ACCESS_KEY_ID=RjcSdMxMiiGYycQV
AWS_SECRET_ACCESS_KEY=jCq9hAvsW4lmMzLzdyuvmoX7dqBpSc7W
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=nmrxiv
AWS_ENDPOINT=http://localhost:9000/
AWS_URL=http://localhost:9000/
AWS_USE_PATH_STYLE_ENDPOINT=false
AWS_BUCKET_PUBLIC=nmrxiv-public
```

Once the application's Docker containers have been started, you can access the application in your web browser at [http://localhost](http://localhost). But first, you will be prompted to <b>Generate app key</b>. After pressing the generation button, the following message is shown on the screen: "The solution was executed successfully. Refresh now." After refreshing, you can access the application.

Run `code .` to open the code base to your VSCode editor.
Expand Down

0 comments on commit 3ed88a6

Please sign in to comment.