clarlify build vs deploy

master
David Kebler 2023-09-15 10:04:29 -07:00
parent 35a8626222
commit 40a01fa781
1 changed files with 3 additions and 1 deletions

View File

@ -1,11 +1,13 @@
# UCI - Live Documetation in a Container # UCI - Live Documetation in a Container
** A self contained live documenation system for editing and displaying documentation via the browser** **A self contained live documenation system for editing and displaying documentation via the browser**
This repo will build an alpine image complete with a mkdocs-material and vscode servers. This repo will build an alpine image complete with a mkdocs-material and vscode servers.
## Deploy ## Deploy
if you are using a prebuilt image then you can deploy per below. Otherwise follow directions for building first
* Copy the deploy directory from this repo to your machine that has docker and docker-compose installed * Copy the deploy directory from this repo to your machine that has docker and docker-compose installed
* Make a copy of the .env.example file to .env and edit as needed. * Make a copy of the .env.example file to .env and edit as needed.
* Edit the docker-compose.yml as needed. * Edit the docker-compose.yml as needed.