mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-23 00:05:09 +00:00
fix: Update setup & deploy instructions
This commit is contained in:
JJ-Cronos
parent
069de7d72a
commit
0d7c9bb5a2
1 changed files with 70 additions and 82 deletions
152
README.md
152
README.md
|
|
@ -1,17 +1,18 @@
|
|||
# Getting Started
|
||||
# RAFNAV Docker Setup & Usage
|
||||
|
||||
## !! You need to be connected to WSL before proceeding
|
||||
## Development
|
||||
|
||||
### Other Pre-requisites
|
||||
> !! You need to be connected to WSL before proceeding
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
To get started, you must have set up an [IT Workspace environment](https://steed-finance.atlassian.net/wiki/x/CQCQBg).
|
||||
After that, clone this repo:
|
||||
|
||||
## Introduction
|
||||
### Introduction
|
||||
|
||||
You will be working in the ```./development``` folder a.k.a. a dev workspace. Follow the steps below to set up the workspace.
|
||||
|
||||
## Workspace Setup
|
||||
### Workspace Setup
|
||||
|
||||
1. Clone the Repo into your working directory
|
||||
|
||||
|
|
@ -35,74 +36,24 @@ Run the following command in your working directory
|
|||
docker build -t rafnav_bench:latest ./images/rafnav_bench
|
||||
```
|
||||
|
||||
> You may change the tag to the relevant naming convention. However, you need to change the image used for development in the correct docker-compose file: ./.devcontainer/docker-compose.yml
|
||||
> You may change the tag to a more relevant naming convention. However, you need to change the image used for development in the correct docker-compose file: ./.devcontainer/docker-compose.yml
|
||||
|
||||
## Container Initialization
|
||||
### Container Initialization
|
||||
|
||||
You have two options to start the docker container for development:
|
||||
We will be attaching a VS Code window to the docker container workspace. This requires the [dev containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
|
||||
|
||||
1. Opening the folder in VS as a docker container.
|
||||
2. Manually starting the container in the terminal.
|
||||
|
||||
### Reopen the folder in the dev container
|
||||
|
||||
1. Open VsCode in the RAFNAV-Docker folder.
|
||||
1. Open the RAFNAV-Docker folder with Vs Code.
|
||||
2. Open the command pallet with *ctrl + shift + p* or *View->Command Pallet*
|
||||
3. Run the command ```dev containers: Reopen in container```
|
||||
4. Wait for the container to warm up...
|
||||
|
||||
### Manually start the container
|
||||
### GitHub Login (GitHub CLI)
|
||||
|
||||
1. Run the following script
|
||||
|
||||
```sh
|
||||
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
|
||||
|
||||
Run the following script to install a command to start the default RAFNAV container easily.
|
||||
|
||||
```sh
|
||||
echo "alias run-rafnav='cd ~/Documents/RAFNAV-Docker && docker-compose -f .devcontainer/docker-compose.yml up -d && docker exec -e \"TERM=xterm-256color\" -w /workspace/development -it devcontainer-frappe-1 bash'" >> ~/.bash_aliases
|
||||
```
|
||||
|
||||
Now you can run ```run-rafnav``` anywhere in your WSL terminal to start the development container.
|
||||
|
||||
> Note: Your **terminal** is now open in the development workspace. However, the VsCode **window** is not.
|
||||
|
||||
## Starting Development
|
||||
|
||||
### GitHub Login (SSH)
|
||||
|
||||
> Make sure you're setting it up for WSL or Linux
|
||||
|
||||
1. [Check for any existing SSH Key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)
|
||||
2. [Generate an SSH Key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
|
||||
3. [Add it to your GitHub](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)
|
||||
4. [Test your connection](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection)
|
||||
- Make sure you have git and Github CLI installed on **windows**
|
||||
- Log in to GitHub from VsCode to sync your github credentials with GitHub
|
||||
|
||||
### RAFNAV Installation
|
||||
|
||||
**‼️ If you're installing on Linux, run the following command first:**
|
||||
|
||||
```sh
|
||||
chown frappe:frappe /workspace/development/
|
||||
```
|
||||
|
||||
#### Default Install
|
||||
|
||||
```sh
|
||||
frap-install -v
|
||||
```
|
||||
|
||||
#### ERPNext with add-on apps
|
||||
|
||||
```sh
|
||||
frap-install -j apps-erpnext.json -v
|
||||
```
|
||||
|
||||
#### Development Branch Apps Install
|
||||
|
||||
```sh
|
||||
|
|
@ -117,23 +68,13 @@ chown frappe:frappe /workspace/development/
|
|||
|
||||
**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. An alias has already been assigned. Run the following command:
|
||||
|
||||
```sh
|
||||
cd rafnav_bench
|
||||
go-rafnav_bench
|
||||
```
|
||||
|
||||
> Run the following script to add an alias for navigating to the RAFNAV bench.
|
||||
|
||||
```sh
|
||||
echo "alias go-rafnav_bench='cd ~/Documents/RAFNAV-Docker/development/rafnav_bench'" >> ~/.bash_aliases
|
||||
```
|
||||
|
||||
Now you can use ```go-rafnav_bench``` anywhere in linux to navigate to RAFNAV's bench directory.
|
||||
|
||||
3. Now you are able to start development on RAFNAV with all the dependencies and the correct environment set-up.
|
||||
|
||||
## Documentation
|
||||
1. Now you are able to start development on RAFNAV with all the dependencies and the correct environment set-up.
|
||||
|
||||
### Default Credentials
|
||||
|
||||
|
|
@ -180,7 +121,7 @@ First site's Administrator password: admin
|
|||
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
|
||||
export APPS_JSON_BASE64=$(base64 -w 0 /path/to/apps.json)
|
||||
export APPS_JSON_BASE64=$(base64 -w 0 apps.json)
|
||||
```
|
||||
|
||||
### Image Build
|
||||
|
|
@ -188,16 +129,14 @@ export APPS_JSON_BASE64=$(base64 -w 0 /path/to/apps.json)
|
|||
Build the production version of the image using
|
||||
|
||||
```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:prod --file=images/production/Containerfile .
|
||||
```
|
||||
|
||||
> Remeber to replace [version] with the correct version number
|
||||
|
||||
### Publish Image
|
||||
|
||||
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 if not already
|
||||
|
||||
```sh
|
||||
docker login -u [username]
|
||||
|
|
@ -207,9 +146,58 @@ docker login -u [username]
|
|||
3. Push the image using the following command:
|
||||
|
||||
```sh
|
||||
docker push rafnav/rafnav_bench:[version]
|
||||
docker push rafnav/rafnav_bench:prod
|
||||
```
|
||||
|
||||
## Common Issues
|
||||
|
||||
### 1. Access denied for user [db user]@[host] (using password: YES)")
|
||||
|
||||
1. Attach a shell to the mariadb container
|
||||
|
||||
```sh
|
||||
docker exec -it rafnav-db-1 bash
|
||||
```
|
||||
|
||||
2. Log in as root user
|
||||
|
||||
```sh
|
||||
mariadb -p
|
||||
```
|
||||
|
||||
At the prompt, enter the db root password that can be found in the compose or project env file
|
||||
|
||||
3. In a new terminal exec into the backend container
|
||||
|
||||
```sh
|
||||
docker exec -it rafnav-backend-1 bash
|
||||
```
|
||||
|
||||
4. Show the db info from the site's config file
|
||||
|
||||
```sh
|
||||
cat sites/[sitename]/site_config.json
|
||||
```
|
||||
|
||||
5. Create the a new DB user
|
||||
|
||||
```SQL
|
||||
CREATE USER [db_name]@[host] IDENTIFIED BY [db_password];
|
||||
```
|
||||
|
||||
6. Grant all privilges to the correct db for the newly created user
|
||||
|
||||
```sh
|
||||
GRANT ALL PRIVILEGES ON [db_name].* TO [db_name]@[host] IDENTIFIED BY [db_password];
|
||||
```
|
||||
|
||||
> Keep the .* after the db_name
|
||||
|
||||
host= IP address from the error message \
|
||||
db_name= DB name contained in the config file \
|
||||
db_password= Password from the config file
|
||||
|
||||
|
||||
## Resources
|
||||
|
||||
### [Production](#production)
|
||||
|
|
|
|||
Loading…
Reference in a new issue