epistemophiliac/frappe_docker
1
0
Fork 0
mirror of https://github.com/frappe/frappe_docker.git synced 2026-06-23 00:05:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

style: format ReadME.md

Browse source
This commit is contained in:
JJ-Cronos 2025-03-31 14:38:18 +02:00
parent f06c9b7c04
commit 84c2c77b99
1 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -59,6 +59,7 @@ You have two options to start the docker container for development:
docker-compose -f .devcontainer/docker-compose.yml up -d && docker exec -e \"TERM=xterm-256color\" -w /workspace/development -it devcontainer-frappe-1 bash docker-compose -f .devcontainer/docker-compose.yml up -d && docker exec -e \"TERM=xterm-256color\" -w /workspace/development -it devcontainer-frappe-1 bash
``` ```
#### Easier container start command #### Easier container start command
Run the following script to install a command to start the default RAFNAV container easily. Run the following script to install a command to start the default RAFNAV container easily.
@ -85,6 +86,7 @@ Now you can run ```run-rafnav``` anywhere in your WSL terminal to start the deve
### RAFNAV Installation ### RAFNAV Installation
**‼️ If you're installing on Linux, run the following command first:** **‼️ If you're installing on Linux, run the following command first:**
```sh ```sh
chown frappe:frappe /workspace/development/ chown frappe:frappe /workspace/development/
``` ```
@ -113,7 +115,6 @@ chown frappe:frappe /workspace/development/
frap-install -j apps-prod.json -v frap-install -j apps-prod.json -v
``` ```
**Note: For additional args and configs run ```frap-install --help``` first.** **Note: For additional args and configs run ```frap-install --help``` first.**
2. cd into Rafnav's development bench 2. cd into Rafnav's development bench
@ -121,6 +122,7 @@ chown frappe:frappe /workspace/development/
```sh ```sh
cd rafnav_bench cd rafnav_bench
``` ```
> Run the following script to add an alias for navigating to the RAFNAV bench. > Run the following script to add an alias for navigating to the RAFNAV bench.
```sh ```sh
@ -134,6 +136,7 @@ Now you can use ```go-rafnav_bench``` anywhere in linux to navigate to RAFNAV's
## Documentation ## Documentation
### Default Credentials ### Default Credentials
MariaDB Root Password: 123 MariaDB Root Password: 123
> Unless changed in the docker or docker-compose file > Unless changed in the docker or docker-compose file
@ -142,8 +145,11 @@ First site's Administrator password: admin
> Unless changed in the docker or docker-compose file > Unless changed in the docker or docker-compose file
## Deployment ## Deployment
### Apps List ### Apps List
1. Specify a list of apps in a JSON file called 'apps.json' 1. Specify a list of apps in a JSON file called 'apps.json'
```json ```json
[ [
{ {
@ -168,32 +174,44 @@ First site's Administrator password: admin
} }
] ]
``` ```
>Note: {{PAT}} replace with your personal access token from GitHub >Note: {{PAT}} replace with your personal access token from GitHub
2. Generate a Base 64 shell variable of the apps list. This will be passed as a build argument for the docker image later 2. Generate a Base 64 shell variable of the apps list. This will be passed as a build argument for the docker image later
```sh ```sh
export APPS_JSON_BASE64=$(base64 -w 0 /path/to/apps.json) export APPS_JSON_BASE64=$(base64 -w 0 /path/to/apps.json)
``` ```
### Image Build ### Image Build
Build the production version of the image using Build the production version of the image using
```sh ```sh
docker build --build-arg=APPS_JSON_BASE64=$APPS_JSON_BASE64 -t rafnav/rafnav_bench:[version] --file=images/production/Containerfile . docker build --build-arg=APPS_JSON_BASE64=$APPS_JSON_BASE64 -t rafnav/rafnav_bench:[version] --file=images/production/Containerfile .
``` ```
> Remeber to replace [version] with the correct version number > Remeber to replace [version] with the correct version number
### Publish Image ### Publish Image
Publish the newly built docker image to docker hub using your PAT from Docker Hub Publish the newly built docker image to docker hub using your PAT from Docker Hub
1. Log in to Docker 1. Log in to Docker
```sh ```sh
docker login -u [username] docker login -u [username]
``` ```
2. At the password prompt, paste your PAT 2. At the password prompt, paste your PAT
3. Push the image using the following command: 3. Push the image using the following command:
```sh ```sh
docker push rafnav/rafnav_bench:[version] docker push rafnav/rafnav_bench:[version]
``` ```
## Resources
### [Production](#production) ### [Production](#production)
- [List of containers](docs/list-of-containers.md) - [List of containers](docs/list-of-containers.md)