diff --git a/.lli/README.md b/.lli/README.md deleted file mode 100644 index b7e4ab41e2482..0000000000000 --- a/.lli/README.md +++ /dev/null @@ -1,102 +0,0 @@ -# Local Quickstart - -You must have the following dependencies installed and in your `PATH`: -* Docker -* Git + Git Bash -* JQ - -First, ensure the `lli-infra` repo is cloned next to our NextCloud `server` repo: - -``` - - lli-infra/ - server/ -``` - -Always use Git Bash when working with this NextCloud setup. In VSCode, you can open a Git Bash terminal by: -- Press Ctrl + ~ to open the terminal panel -- Click the caret next to the "+" icon at the top of the terminal panel -- Select "Git Bash" - -All scripts should be run from this directory: - -```bash -cd ncloud/docker/modern -``` - -To start NextCloud locally, run: - -```bash -./local.sh up then-init -``` - -This builds and starts a Docker Compose of NextCloud and supporting services, then automatically initializes the database and triggers the NextCloud install. - -NextCloud will now be installed and running at http://localhost. The default administrator credentials are: - -```bash -Username: admin -Password: admin -``` - -After making a code change in your local repos, run the following to apply the changes to the deployment. - -```bash -./local.sh update -``` - -If the change involves Vue or other built JS code, add the `rebuild-js` flag: - -```bash -./local.sh update rebuild-js -``` - -To shut the deployment down, run: - -```bash -./local.sh down -``` - -Or, if you want to retain all the data for next time: - -```bash -./local.sh down save-vols -``` - -This will shut down and destroy all containers, but leave volumes in place. If you shut down this way, you do not need to re-initialize the next time you run NextCloud, so start it with simply: - -```bash -./local.sh up -``` - -# Container - -This container uses Nginx as a webserver and PHP Fast Process Manager (FPM) as the PHP executor upstream. - -The filesystem layout is: - -``` -/ncloud - /server NextCloud server and plugins. - /data Mounted storage volume. - /php-fpm.sock Socket file for FPM (Nginx upstream target). -/etc/php//fpm - /php-fpm.conf Global FPM configuration. - /pool.d/www.conf FPM pool configuration. -/etc/nginx/nginx.conf Nginx config. -``` - -The required runtime environment variables are: - -``` -NGINX_PORT The port number Nginx should listen on. -NGINX_INTERNAL_HOST The internal URL on which the site is hosted, without the protocol. -NGINX_EXTERNAL_HOST The external URL on which the site is hosted, without the protocol. -NGINX_PATH_PREFIX The URL prefix NextCloud lives on, on the hostname. -CDSP_UNASSIGNED_GROUPS A comma-separated list of groups new users are assigned to. -CDSP_RESTRICTED_GROUPS A comma-separated list of groups whose members logins are restricted by realm. -CDSP_ADMIN_GROUPS A comma-separated list of groups whose members are considered administrators. -AWS_ACCESS_KEY_ID Access Key for the AWS credential. -AWS_SECRET_ACCESS_KEY Secret Key for the AWS credential. -AWS_BUCKET AWS Bucket name. -``` diff --git a/LLI_README.md b/LLI_README.md index 653aaef1c15a9..3b539d98d839e 100644 --- a/LLI_README.md +++ b/LLI_README.md @@ -7,21 +7,42 @@ We use Git Submodules to manage additional repositories involved in our NextClou - Our app, `cdsp` - Several apps from the NextCloud ecosystem -# Instruction Manual - To clone this repo, run: ```bash git clone --recurse-submodules ``` -Clone this repo in the same directory as the `lli-infra` repo to allow the scripts in that repo to function properly. +Clone this repo in the same directory as the `lli-infra` repo to allow the scripts in that repo to function properly: -For example: ``` -lli/ +/ lli-infra/ server/ ``` +# LLI Container + +The `.lli` directory contains build configuration for a NextCloud container which uses Nginx as a webserver and PHP Fast Process Manager (FPM) as the PHP executor upstream. + +The filesystem layout is: + +``` +/ncloud + /server NextCloud server and plugins. + /data Mounted storage volume. + /php-fpm.sock Socket file for FPM (Nginx upstream target). +/etc/php//fpm + /php-fpm.conf Global FPM configuration. + /pool.d/www.conf FPM pool configuration. +/etc/nginx/nginx.conf Nginx config. +``` + +Run the following in __Bash__ to build the container: + +```bash +cd .lli +./build.sh +``` + *Document incomplete*