Skip to content

Commit

Permalink
Merge pull request #215 from mlibrary/doc-patch
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
billdueber authored Sep 27, 2024
2 parents 98c83ef + 8e48f85 commit f86f96b
Showing 1 changed file with 2 additions and 77 deletions.
79 changes: 2 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ Confusingly, there are three separate repositories:
solr configuration, in particular the suggesters (for autocomplete).
* [Tour of the application code](docs/application_code.md) is a quick look at how
the MED differs from a stock Rails application.
* [Deployment to production](docs/deployment.md) shows the steps for building the
correct image and getting it running on the production cluster, as well as
how to roll back if something went wrong.


### Access links
* **Public-facing application**: https://quod.lib.umich.edu/m/middle-english-dictionary/
Expand All @@ -44,82 +42,9 @@ Confusingly, there are three separate repositories:
This repo currently runs on Ruby 2.x and Blacklight 5.x, and there are no plans
to upgrade either.


<pre>



</pre>

<hr>
<hr>




# OLD STUFF

* [Indexing new data](docs/indexing.md), when new data is made available.

For developers:
* [Overview: what can you do with the bin/dromedary helper script?](docs/dromedary_executable.md)
* [Deploying new _code_](docs/deploying.md) for when changes have been made
to the rails application, or solr config.
* [How to set up autocomplete for multiple search fields](docs/autocomplete_setup.md)
* [Quick and easy(?) instructions](docs/setting_up_dev_environment_on_unix_or_mac.md) for the initial setup

## Setting maintenance mode

Maintenance mode (where folks get a message that the MED is down) happens
automatically during indexing. If it needs to be set for some other
reason (e.g., the solr is down or something):

* `ssh deployhost exec dromedary-production "bin/dromedary maintenance_mode on"`
* `ssh deployhost exec dromedary-production "bin/dromedary maintenance_mode off"`


## Development Quick Start

### SUPER quick start

The steps enumerated and explained below can be run via `bin/setup_dev.sh`.

#### Handy Dandy Aliases (Optional)
```shell
alias dc="docker-compose"
alias dce="dc exec --"
alias abe="dce app bundle exec"
```
### Build application and solr image
The default is **amd64** architecture a.k.a. Intel
```shell
docker-compose build app
docker-compose build solr
```
For Apple Silicon use **arm64** architecture
```shell
docker-compose build --build-arg ARCH=arm64 app
docker-compose build --build-arg ARCH=arm64 solr
```
### Login into docker GitHub packages
```shell
docker login ghcr.io --username <github-user> --password <personal-access-token>
```
### Bring up development environment
```shell
docker-compose up -d
```


Verify the application is running http://localhost:3000/

## Bring it all down then back up again
```shell
docker-compose down
```
```shell
docker-compose up -d
```

Note that there's no data in it yet, so lots of actions will throw errors. It's time
to index some data.
to index some data.

0 comments on commit f86f96b

Please sign in to comment.