diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml index 73edb11..48dd6ca 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -17,4 +17,4 @@ jobs: host: ${{ secrets.DEPLOYMENT_HOST }} username: ${{ secrets.DEPLOYMENT_USERNAME }} password: ${{ secrets.DEPLOYMENT_PASSWORD }} - script: cd simple-media-converter/ && ./scripts/deploy.sh smc + script: cd simple-media-converter/ && ./scripts/deploy.sh simple-media-converter diff --git a/README.md b/README.md index c41b946..404d49e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@

- + +

@@ -68,20 +69,18 @@ The following section will guide you through setting up your own Simple Media Co #### Docker For deployment, Docker is the preferred approach, especially if you would like to avoid the hassle of manually installing dependencies. If you are unfamiliar with docker, it is recommended you go through a quick tutorial for it first. This section **will not** dive into the details of docker usage. -1) First, if you have not done so, create a *.env* file from the provided [*.env.template*](https://github.com/tjtanjin/simple-media-converter/blob/master/.env.template) and update the variables (at the very least the **BOT_TOKEN**). If you have made code changes to the project, proceed to **step 2**. Otherwise, if you are using the project as it is, proceed to **step 3**. -2) Since you have made code changes to the project, you would have to build your own docker image with the following command (take note to replace the tag `-t` with that of your own): +1) First, if you have not done so, create a *.env* file from the provided [*.env.template*](https://github.com/tjtanjin/simple-media-converter/blob/master/.env.template) and update the variables (at the very least, you need to input a valid **BOT_TOKEN**). +2) If you using the project as it is (**i.e. no intended code changes**), then simply run `./deploy.sh` within the scripts folder and your deployment will be automatically done! Otherwise, if you wish to make code changes to the project, please read on. +3) Once you are done with your code changes, you would have to build your own docker image with the following command (take note to replace the tag `-t` with that of your own): ``` $ docker build -t tjtanjin/simple-media-converter . ``` -3) Since you are using the project as it is, go ahead to pull my image with the following command: - ``` - $ docker pull tjtanjin/simple-media-converter:master - ``` -4) Once you have your desired image (obtained either via **step 2 or 3**), you may then start your container with the following command (remember to replace image name below if you built your own image): +4) Upon obtaining your image, you may then start your container with the following command (remember to replace image name below if you built your own image): ``` $ docker run -d --name smc --env-file .env tjtanjin/simple-media-converter:master ``` - Note: Notice that the *.env* file we configured in **step 1** is being passed via the `--env-file` argument. Hence, ensure that you have setup your configuration properly before passing in the file. + Note: Notice that the *.env* file we configured in **step 1** is being passed via the `--env-file` argument. This is true for the auto deployment in **step 2** as well. Hence, ensure that you have setup your configuration properly before passing in the file. +5) Finally, you may wish to **update the deployment script** to reference your own image/container if you would like to have an easier deployment workflow. #### Manual @@ -91,7 +90,7 @@ Alternatively, if you are unfamiliar with docker or would like a more manual app * [Tan Jin](https://github.com/tjtanjin) ### Contributing -If you wish to make code contributions to the project, then please be advised to give the [Developer Guide](https://github.com/tjtanjin/simple-media-converter/blob/master/docs/DeveloperGuide.md) a read. Once you are ready, feel free to open a pull request and describe clearly the changes and what they are intended to do (enhancement, bug fixes etc). +If you wish to make code contributions to the project, then please be advised to give the [*Developer Guide*](https://github.com/tjtanjin/simple-media-converter/blob/master/docs/DeveloperGuide.md) a read. Once you are ready, feel free to open a pull request and describe clearly the changes and what they are intended to do (enhancement, bug fixes etc). Alternatively, you may simply raise bugs or suggestions by opening an issue.