diff --git a/README.md b/README.md index c34a990..32a92ae 100644 --- a/README.md +++ b/README.md @@ -4,70 +4,11 @@ # Tripal Crop Docker -This docker container contains all the Drupal, Tripal and DivSeek Canada extension modules you need to create your own Tripal Crop site. Furthermore, it contains a number of command-line drush commands to make maitenance and administration of your Tripal crop site more streamlined. +[![](https://divseek-canada.github.io/tripal-crop-docker/public/full-website-capture.png)](https://divseek-canada.github.io/tripal-crop-docker) -**The Tripal Crop Docker does NOT include any data or configuration in current releases. Manual configuration of the Tripal Crop site is required. Check the future work to see plans for upcoming releases.** +## Documentation -## Data Types - -*The following data types are fully supported in Tripal Crop Docker. Specifically, the full data lifecycle from import, visualization, integration and download is managed. Furthermore, all data is made FAIR through searches, web services, extensive metadata support, summaries, relationships between data points + types, display of integrated data on record pages and multi-format downloads.* - -- Germplasm passport & pedigree -- Phenotypic traits -- Phenotypic experiments & measurements -- Genotypic experiments & calls -- Sequence variants & genetic markers -- Genetic maps & loci -- Quantitative trait loci (QTL) -- Genome assemblies & gene sets - -## Software Stack - -*The following software exists within the current tripal-crop-docker image. NOTE: PostgreSQL is inside the same image as Drupal for security reasons as it allows us to close incoming ports.* - -- Tripal 3.4 -- Drupal 7.73 -- Composer 2.0.2 -- Drush 8.4.5 -- PHP 7.4.11 -- PostgreSQL 11.9 -- Apache 2.4.38 -- Debian 10 (buster) - -In addition, the tripal-crop-docker contains a large number of Tripal extension modules to support crop research and breeding activities. - -## Usage - -1. Pull the most recent image from the Github Package Repository. -``` -docker pull docker.pkg.github.com/divseek-canada/tripal-crop-docker/tripal-crop-docker:1.1 -``` - -2. Create a running container exposing the website at localhost:9010 - -*To customize the installed site, change the variables available in the .env file without removing any.* **Make sure to change DBPASS and ADMINPASS for security reasons.** - -``` -docker run --publish=9010:80 --name=tcrop -tid \ - -e DBPASS='some secure password!' \ - -e ADMINPASS='another secure password!' \ - --env-file=.env \ - docker.pkg.github.com/divseek-canada/tripal-crop-docker/tripal-crop-docker:1.1 -``` - -3. Provision the container including installation of the software stack. - -``` -docker exec -it tcrop /app/init_scripts/startup_container.sh -``` - -## Future Work -- create a tripal extension module with drush commands - - install and configure defaults for all Modules - - add permissions and roles which make sense -- create command-line bash commands for easy site management - - Certbot: create/renew certificate - - Upgrade? upgrades drupal and all extension modules +For our usage instuctions and all our documentation, [click here or on the image above](https://divseek-canada.github.io/tripal-crop-docker). ## Funding