expand/CCash
1
0
Fork 0
mirror of https://github.com/Expand-sys/CCash synced 2025-12-17 00:22:14 +11:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update deploy.md

Browse source
This commit is contained in:
Expand-sys 2021-08-01 12:11:40 +10:00 committed by GitHub
parent ab41a7ed46
commit 942e6b702a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
docs/deploy.md
View file

@ -11,37 +11,23 @@ docker run -itp 443:443 -v ccashconfig:/ccash/config -e ADMIN_A=<admin-username>
``` ```
## Build ## Build
Previously this used GitHub Workflows, I(Expand) dont know how to do those but its not that hard to deploy stuff manually. To run the pre configured docker image run the above command and you are off to the races it will deploy a self signed certificate and use that for deployment. As this is not a user facing deployment the certificate is self signed and thus will throw an error on chrome, though this will still work if you ignore it. For production you should deploy with a reverse proxy and a correct certificate for your domain.
The CCash repo provides a GitHub Workflow to build, release and publish the docker image in [.github/workflows/build.yaml](https://github.com/EntireTwix/CCash/blob/main/.github/workflows/build.yaml) to the GitHub Packages container registry. To build this manually you may download the dockerfile only, it will pull the latest repository the commands for building are
```
You can build and publish your own images using this workflow by forking [EntireTwix/CCash](https://github.com/EntireTwix/CCash). docker build --build-arg ADMIN_A=<admin-username> --build-arg SAVE_FREQ=<in minutes> -t ccash . --no-cache
docker run -itp 443:443 -v ccashconfig:/ccash/config -e ADMIN_A=<admin-username> -e SAVE_FREQ=<in minutes> ccash
```
if you have the know how you may edit the docker file and add CMAKE commands as listed in the build section of the CCash documentation.
## Deploy ## Deploy
You can deploy this docker image to be run on a remote machine in a few steps. In this case we are using [Debian OS](https://www.debian.org/) running on the [Linode](https://www.linode.com/) cloud provider, but most OS and cloud providers will work, assuming the machine can run an SSH server and Docker. You can deploy this docker image to be run on a remote machine in a few steps or you can deploy manually in this case we are using [Debian OS](https://www.debian.org/) running on the [Linode](https://www.linode.com/) cloud provider, but most OS and cloud providers will work, assuming the machine can run an SSH server.
Similarly, the CCash repo also provides a GitHub Workflow to deploy the latest docker image to a remote machine in [.github/workflows/deploy.yaml](https://github.com/EntireTwix/CCash/blob/main/.github/workflows/deploy.yaml). Additionally, there is a dockerfile where you can build it yourself or a repository available on [dockerhub](https://hub.docker.com/r/expandsys/ccash) for you to just pull and run on any machine quickly and easily.
### Configure the machine ### Configure the machine
For docker deployment there is one supported config and that is the command listed above,
ADMIN_A = Admin account name, must be all lowercase, and the account must be created before use. To do this either use the [CCashDeploy](https://hub.docker.com/r/expandsys/ccashdeploy) docker image and use the CCashFrontend to register the account or use curl to send the raw command to the endpoint.
SAVE_FREQ = Saving frequency in minutes, pretty simple
1. Create a machine using your chosen cloud provider
1. Configure DNS to point your chosen domain name to the machines IP address. _(Without this, TLS/SSL will not work)_
1. Create an SSH key-pair by running `ssh-keygen` locally. Make sure you **don't** set a password
1. Add the `*.pub` public key to the servers `~/.ssh/authorized_keys` file
1. Install Docker Engine on the remote machine following [official docs](https://docs.docker.com/engine/install/)
1. Generate SSL/TLS certificate (Using [certbot](https://certbot.eff.org/lets-encrypt/debianbuster-other) is recommended)
1. Configure [GitHub secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) for the repo
* `CCASH_SSH_KEY` - The private key _(not `*.pub`)_ created earlier
* `CCASH_DOMAIN` - The domain name pointing to the remote machine
* `CCASH_CONFIG_JSON` - A config.json file that will be written every deploy _(https config cert path should be `/ccash/cert` and key path should be `/ccash/key`)_
* `CCASH_USERS_JSON` - A users.json file that will be written only on first deploy
* `CCASH_ADMIN_PASSWORD` - A CCash server admin account password
* `CCASH_SAVE_FREQUENCY` - A number representing the frequency to save to users.json (in minutes)
* `CCASH_THREAD_COUNT` - A number representing the number of threads to use
* `CCASH_TLS_CERT_PATH` - The path to the TLS/SSL certificate on the host machine
* `CCASH_TLS_KEY_PATH` - The path to the TLS/SSL key on the host machine
* `CCASH_DEPLOY_TOKEN` - A [GitHub personal access token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token), used to trigger the deploy workflow automatically when the build workflow is successful. _(Leave empty to disable automatic deploys.)_
You are now ready to run the "Deploy" workflow mentioned above. This workflow will SSH in to the `CCASH_DOMAIN` machine, using the `CCASH_SSH_KEY` and `docker run` the latest `entiretwix/ccash` image, binding to port 80 and 443, setting the appropriate volumes and environment variables.
Run `curl https://$CCASH_DOMAIN/BankF/ping` to verify that the server has been deployed correctly.