Skip to content
Merged

v0.16.1 #1011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
135 commits
Select commit Hold shift + click to select a range
4f04a1d
Extended biopax zip download service with id mapping parameter
metincansiper Nov 19, 2020
35229b1
Query ncbi to uniprot id mappings chunk by chunk.
metincansiper Nov 19, 2020
91ebbd1
A little code reorganization for mapping ncbi ids to uniprot ids.
metincansiper Nov 19, 2020
d2697dc
Use a different file name while downloading the biopax zip files if t…
metincansiper Nov 19, 2020
3b81395
Merge branch 'unstable' into biopax_id_mapping
metincansiper Nov 19, 2020
12c42a8
Use assoc.dbprefix for mapping ids to uniprot ids.
metincansiper Nov 20, 2020
5d09849
Merge branch 'biopax_id_mapping' of https://github.com/PathwayCommons…
metincansiper Nov 20, 2020
dc2f324
Added swagger documentation for biopax id mapping parameter.
metincansiper Nov 20, 2020
53f4068
Merge pull request #904 from PathwayCommons/biopax_id_mapping
maxkfranz Nov 23, 2020
52086e5
Automatic connection of researcher profiles #907
metincansiper Nov 26, 2020
fdf4a3e
Query orcid urls of authors on server side.
metincansiper Dec 1, 2020
376b92a
Fixed linting errors
metincansiper Dec 1, 2020
bba32bf
Merge pull request #910 from PathwayCommons/author_page_link
maxkfranz Dec 2, 2020
bcc98b8
Avoid edge arrow overlap with labels #908
maxkfranz Dec 2, 2020
678f7e5
In summary page use the old way of showing author names when author p…
metincansiper Dec 2, 2020
784ff6b
Merge pull request #912 from PathwayCommons/author_page_link
maxkfranz Dec 7, 2020
3a993ef
Merge pull request #911 from PathwayCommons/arrow-overlap
maxkfranz Dec 7, 2020
92cc756
Add a catch condition that inserts a dummy article only when none pre…
jvwong Dec 8, 2020
d0a6aa2
Only insert related papers in catch if there weren't any before.
jvwong Dec 8, 2020
02dfce8
Add the CRON schedule as configurable from docker-compose
jvwong Dec 9, 2020
39424e9
Merge pull request #916 from PathwayCommons/iss914_update-fail-gently
maxkfranz Dec 9, 2020
8a520f7
Bump ini from 1.3.5 to 1.3.7
dependabot[bot] Dec 10, 2020
3fb0b53
Refactored RequestForm as a reusable component. (#913)
metincansiper Dec 14, 2020
711b253
Add ORCID icon to set of custom icons
maxkfranz Dec 21, 2020
0e06b3a
In PATCH `/api/document` `op=replace value=article`, fill author prof…
maxkfranz Dec 21, 2020
5e0da07
Update the author profile links to use comma separators and ORCID icons
maxkfranz Dec 21, 2020
39461a5
Improved in-editor title editing
maxkfranz Dec 21, 2020
c092cff
Add credits: Shows the name & ORCID link of the contributing author i…
maxkfranz Dec 21, 2020
96ebfc8
The admin interface doesn't need to validate the inputs. They can be…
maxkfranz Dec 21, 2020
24b90ee
Merge pull request #921 from PathwayCommons/post-hoc-titles-etc
maxkfranz Dec 22, 2020
0817428
AuthorProfiles: Provide error handling, fallback (for orcid) #923
metincansiper Jan 5, 2021
a151066
Merge pull request #924 from PathwayCommons/author_profiles_error
maxkfranz Jan 6, 2021
a028160
Merge pull request #917 from PathwayCommons/dependabot/npm_and_yarn/i…
maxkfranz Jan 6, 2021
bdb6dfd
- Include page url param
jvwong Jan 6, 2021
6dcd790
Merge pull request #926 from PathwayCommons/iss922_admin-url-offset
jvwong Jan 7, 2021
bc7e037
Consider complex transformation for invalid interaction templates as …
metincansiper Jan 14, 2021
0c54a28
Added pathway id parameter to be consumed in factoid to biopax conver…
metincansiper Jan 15, 2021
32110cf
0.13.0
jvwong Jan 29, 2021
7f35ffc
0.14.0
jvwong Jan 29, 2021
95e0f53
Merge pull request #930 from PathwayCommons/v0.14.0
maxkfranz Feb 8, 2021
0da73e3
One-click editor link for related papers emails
maxkfranz Jan 18, 2021
b4b579d
- Support for the Nginx proxy
jvwong Feb 9, 2021
d69cae8
Merge pull request #934 from PathwayCommons/iss933_docker-nginx
jvwong Feb 9, 2021
eb58cd2
Jeff and Max debugging #935
maxkfranz Feb 11, 2021
10aa5d7
- Client waits MAX_WAIT_TWEET ms for doc tweet info
jvwong Feb 11, 2021
4a1203f
Merge pull request #936 from PathwayCommons/tweet-935
jvwong Feb 12, 2021
3d6443f
Merge pull request #932 from PathwayCommons/reld-pprs-email-link
maxkfranz Feb 15, 2021
9355973
Single ORCID query for each paper (#941)
metincansiper Feb 25, 2021
d0b50f9
Remove the files and documentation for Docker and refer to factoid-do…
jvwong Mar 2, 2021
a58eb3d
Include reference to Docker Hub
jvwong Mar 2, 2021
4ffbf3f
Merge pull request #944 from PathwayCommons/iss942_remove-docker-dir
jvwong Mar 2, 2021
3a6a1ed
Add the MAX_WAIT_TWEET to client vars
jvwong Mar 9, 2021
e5d4d16
Merge pull request #946 from PathwayCommons/iss935_add-tweet-var
jvwong Mar 10, 2021
39bf8fa
Use the bioRxiv link
jvwong Mar 15, 2021
b20982d
Merge pull request #948 from PathwayCommons/iss947_read-our-paper
jvwong Mar 15, 2021
e6766fa
Emek contact should be OHSU.
jvwong Mar 17, 2021
4aed3ee
Merge pull request #950 from PathwayCommons/iss949_contact-typo
jvwong Mar 17, 2021
adbd0cc
Move the npm build command to the entrypoint, so it recognizes the en…
jvwong Mar 22, 2021
75f84d4
Supplement db improvements (#940)
metincansiper Mar 23, 2021
ab8d0ee
The master subdomain of grounding.baderlab.org is now discontinued.
jvwong Mar 24, 2021
5c1a369
Merge pull request #954 from PathwayCommons/default-grounding-URL
jvwong Mar 24, 2021
adf3381
Merge branch 'unstable' into iss953_missing-doi
jvwong Mar 24, 2021
e6597d0
Check for doi and adjust accordingly
jvwong Mar 24, 2021
3371008
Merge pull request #952 from PathwayCommons/iss951_docker-build-baseUrl
jvwong Mar 31, 2021
dade355
Show related papers for complex
jvwong Apr 5, 2021
bfcc042
Merge pull request #963 from PathwayCommons/iss960_complex-relatedPapers
maxkfranz Apr 6, 2021
12a6768
Author attribution overlaps the share button #958
maxkfranz Apr 14, 2021
f2c0002
Merge pull request #955 from PathwayCommons/iss953_missing-doi
maxkfranz Apr 14, 2021
6fbffb2
Merge pull request #964 from PathwayCommons/share-credit-overlap-958
maxkfranz Apr 21, 2021
8fd50e7
0.15.0
jvwong May 5, 2021
e1f467e
Merge pull request #968 from PathwayCommons/v0.15.0
jvwong May 5, 2021
f799821
Add back the deleted code for emailing a newly signed up user. Also a…
jvwong May 7, 2021
0c18866
Directly force database name into short synonym field
jvwong May 7, 2021
66c9916
Add (remove) the name to (from) the match
jvwong May 10, 2021
0bb39d5
Comments describing logic for dealing with match name
jvwong May 10, 2021
a155a7c
Merge pull request #974 from PathwayCommons/iss973_signup-email-addback
jvwong May 11, 2021
d2a00ef
Compare label to match names in a case-insensitive manner
jvwong May 12, 2021
5234a1a
Merge pull request #976 from PathwayCommons/iss969_keep-name
jvwong May 13, 2021
9a02fac
0.15.1
jvwong May 14, 2021
0b46f70
Merge pull request #978 from PathwayCommons/v0.15.1
jvwong May 14, 2021
54238f3
Document Data License & Privacy Policy
maxkfranz May 25, 2021
390141b
Merge pull request #979 from PathwayCommons/licensing-etc
maxkfranz May 31, 2021
e29dbc6
Update README.md
maxkfranz Jun 2, 2021
95ac0bc
Update README.md
jvwong Jun 2, 2021
8dfed27
Merge pull request #981 from PathwayCommons/zenodo-badge
maxkfranz Jun 2, 2021
517cd89
Update README.md
maxkfranz Jun 2, 2021
825138c
Exclude retractions from the search hits.
jvwong Jun 2, 2021
fa00389
Merge pull request #982 from PathwayCommons/iss848_exclude-retractions
maxkfranz Jun 7, 2021
bef1187
Added initial version of Search class
jvwong Jun 8, 2021
072d76d
An abstract search class and basic document search class
jvwong Jun 8, 2021
1f1cb8a
JS doc added
jvwong Jun 8, 2021
5ed0f46
- return the full (raw) indexed documents in search hits
jvwong Jun 8, 2021
e23ffb9
Move fetch into base-class
jvwong Jun 8, 2021
264b93c
Merge pull request #984 from PathwayCommons/iss863_mini-search
maxkfranz Jun 9, 2021
49667c9
Ignore Visual Studio folder
jvwong Jul 7, 2021
f573649
- for each load of the /demo, swap in a new document with secret 'demo'
jvwong Jul 7, 2021
ff50053
Set doc status as initiated, and trash if demo
jvwong Jul 7, 2021
d6892fa
If a request for new demo is made, skip retrieval of related papers, …
jvwong Jul 8, 2021
5876199
Homepage - "for authors" section added demo button
jvwong Jul 8, 2021
8583e84
Add a real article for demo metadata.
jvwong Jul 8, 2021
ed28abf
Close unsubmitted editor warning
maxkfranz Jul 12, 2021
e3eb335
- Demo doc has initiated status
jvwong Jul 12, 2021
a9ca7c4
Disable warning in dev mode in prep. for merge
maxkfranz Jul 13, 2021
aec719e
Merge pull request #996 from PathwayCommons/close-warning
maxkfranz Jul 13, 2021
830a78c
Merge pull request #995 from PathwayCommons/demo
jvwong Jul 14, 2021
518d96b
Insert a "Retracted Publication" flag in Explorer
jvwong Jul 14, 2021
225262a
Nest the flags, and style accordingly
jvwong Jul 14, 2021
655b617
Explorer flag styled button-like
jvwong Jul 16, 2021
608fefb
Document-level context via caption
maxkfranz Jul 21, 2021
0ce2c0b
Merge pull request #998 from PathwayCommons/iss994_flag-retracted
maxkfranz Jul 21, 2021
065b82d
CRON: Find demo and initiated docs that are empty (no article, entrie…
jvwong Aug 4, 2021
8b27e4f
- set created and lastEdited dates as UNIX time (sec since epoch)
jvwong Aug 6, 2021
7b4234c
Map the createdDate to a rethinkdb time object (backwards compatibili…
jvwong Aug 6, 2021
7b7dbfe
Patch the createdDate - backwards compatible with PTYPE<TIME>
jvwong Aug 6, 2021
6b06500
Make the getDateSafe always return a Date object.
jvwong Aug 6, 2021
81f3488
Accommodate unix time stamps (created, lastEdited dates).
jvwong Aug 6, 2021
fa17f2b
Updating placeholder text.
jvwong Aug 9, 2021
4bfbad2
Tweaking the placeholder.
jvwong Aug 9, 2021
80cc301
Merge pull request #1002 from PathwayCommons/iss1000_normalize-lastEd…
maxkfranz Aug 9, 2021
742ebd8
Merge branch 'unstable' into global-context
maxkfranz Aug 9, 2021
5e2b53e
Merge pull request #999 from PathwayCommons/global-context
jvwong Aug 9, 2021
ea90673
Merge pull request #1001 from PathwayCommons/iss997_cron-delete-docs
jvwong Aug 9, 2021
782a320
Add grounding tests (server side failures re. #965)
maxkfranz Aug 11, 2021
46532c5
Explicitly set `null` (rather than implicitly `undefined`) to ensure …
maxkfranz Aug 11, 2021
afbd378
Update the entity assoc tests with previously failing grounds.
jvwong Aug 12, 2021
66958cf
- ensure that test grounds are independent objects
jvwong Aug 12, 2021
25881e8
Merge pull request #1005 from PathwayCommons/grounding-overwrite
jvwong Aug 13, 2021
2a6cbae
Retrieve counts for number of documents, articles, entities and inter…
jvwong Aug 13, 2021
6dec955
Merge pull request #1006 from PathwayCommons/iss1004_entity-stats
maxkfranz Aug 14, 2021
829ef6f
0.16.0
jvwong Aug 17, 2021
722ee59
Merge pull request #1008 from PathwayCommons/v0.16.0
jvwong Aug 17, 2021
d180ff8
Warn on tab close if not dev mode and doc status is initiated (not su…
jvwong Aug 17, 2021
5a33d8f
Merge pull request #1010 from PathwayCommons/iss1009_modify-warning-d…
jvwong Aug 17, 2021
017d40a
0.16.1
jvwong Aug 17, 2021
d77ac04
Merge branch 'master' into v0.16.1
jvwong Aug 18, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ npm-debug.log
*.iml
/download/*
!/download/README
.vscode
4 changes: 0 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@ RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key
# Note: NODE_ENV is development so that dev deps are installed
RUN NODE_ENV=development npm install

# Build project
RUN npm run clean
RUN npm run build

# Expose port
EXPOSE 3000

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2020 Pathway Commons
Copyright (c) 2020 - 2021 Pathway Commons

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the “Software”), to deal in
Expand Down
56 changes: 56 additions & 0 deletions PRIVACY_POLICY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<h2>Privacy Policy</h2>
<p>Your privacy is important to us. It is Biofactoid&#39;s policy to respect your privacy and comply with any applicable law and regulation regarding any personal information we may collect about you, including across our website, <a href="https://biofactoid.org">https://biofactoid.org</a>, and other sites we own and operate. </p>
<p>This policy is effective as of 25 May 2021 and was last updated on 25 May 2021. </p>
<h3>Information We Collect</h3>
<p>Information we collect includes both information you knowingly and actively provide us when using or participating in any of our services and promotions, and any information automatically sent by your devices in the course of accessing our products and services. </p>
<h4>Log Data</h4>
<p>When you visit our website, our servers may automatically log the standard data provided by your web browser. It may include your device’s Internet Protocol (IP) address, your browser type and version, the pages you visit, the time and date of your visit, the time spent on each page, other details about your visit, and technical details that occur in conjunction with any errors you may encounter. </p>
<p>Please be aware that while this information may not be personally identifying by itself, it may be possible to combine it with other data to personally identify individual persons. </p>
<h4>Personal Information</h4>
<p>We may ask for personal information which may include one or more of the following: </p>
<ul>
<li>Name</li>
<li>Email</li>
<li>Social media profiles</li>
</ul>
<h4>Legitimate Reasons for Processing Your Personal Information</h4>
<p>We only collect and use your personal information when we have a legitimate reason for doing so. In which instance, we only collect personal information that is reasonably necessary to provide our services to you. </p>
<h4>Collection and Use of Information</h4>
<p>We may collect personal information from you when you do any of the following on our website: </p>
<ul>
<li>Use a mobile device or web browser to access our content</li>
<li>Contact us via email, social media, or on any similar technologies</li>
<li>When you mention us on social media</li>
</ul>
<p>We may collect, hold, use, and disclose information for the following purposes, and personal information will not be further processed in a manner that is incompatible with these purposes: </p>
<p>We may collect, hold, use, and disclose information for the following purposes, and personal information will not be further processed in a manner that is incompatible with these purposes: </p>
<ul>
<li>to contact and communicate with you</li>
</ul>
<p>Please be aware that we may combine information we collect about you with general information or research data we receive from other trusted sources. </p>
<h4>Security of Your Personal Information</h4>
<p>When we collect and process personal information, and while we retain this information, we will protect it within commercially acceptable means to prevent loss and theft, as well as unauthorized access, disclosure, copying, use, or modification. </p>
<p>Although we will do our best to protect the personal information you provide to us, we advise that no method of electronic transmission or storage is 100% secure, and no one can guarantee absolute data security. We will comply with laws applicable to us in respect of any data breach. </p>
<p>You are responsible for selecting any password and its overall security strength, ensuring the security of your own information within the bounds of our services. </p>
<h4>How Long We Keep Your Personal Information</h4>
<p>We keep your personal information only for as long as we need to. This time period may depend on what we are using your information for, in accordance with this privacy policy. If your personal information is no longer required, we will delete it or make it anonymous by removing all details that identify you. </p>
<p>However, if necessary, we may retain your personal information for our compliance with a legal, accounting, or reporting obligation or for archiving purposes in the public interest, scientific, or historical research purposes or statistical purposes. </p>
<h3>Children’s Privacy</h3>
<p>We do not aim any of our products or services directly at children under the age of 13, and we do not knowingly collect personal information about children under 13. </p>
<h3>International Transfers of Personal Information</h3>
<p>The personal information we collect is stored and/or processed where we or our partners, affiliates, and third-party providers maintain facilities. Please be aware that the locations to which we store, process, or transfer your personal information may not have the same data protection laws as the country in which you initially provided the information. If we transfer your personal information to third parties in other countries: (i) we will perform those transfers in accordance with the requirements of applicable law; and (ii) we will protect the transferred personal information in accordance with this privacy policy. </p>
<h3>Your Rights and Controlling Your Personal Information</h3>
<p>You always retain the right to withhold personal information from us, with the understanding that your experience of our website may be affected. We will not discriminate against you for exercising any of your rights over your personal information. If you do provide us with personal information you understand that we will collect, hold, use and disclose it in accordance with this privacy policy. You retain the right to request details of any personal information we hold about you. </p>
<p>If we receive personal information about you from a third party, we will protect it as set out in this privacy policy. If you are a third party providing personal information about somebody else, you represent and warrant that you have such person’s consent to provide the personal information to us. </p>
<p>If you have previously agreed to us using your personal information for direct marketing purposes, you may change your mind at any time. We will provide you with the ability to unsubscribe from our email-database or opt out of communications. Please be aware we may need to request specific information from you to help us confirm your identity. </p>
<p>If you believe that any information we hold about you is inaccurate, out of date, incomplete, irrelevant, or misleading, please contact us using the details provided in this privacy policy. We will take reasonable steps to correct any information found to be inaccurate, incomplete, misleading, or out of date. </p>
<p>If you believe that we have breached a relevant data protection law and wish to make a complaint, please contact us using the details below and provide us with full details of the alleged breach. We will promptly investigate your complaint and respond to you, in writing, setting out the outcome of our investigation and the steps we will take to deal with your complaint. You also have the right to contact a regulatory body or data protection authority in relation to your complaint. </p>
<h3>Limits of Our Policy</h3>
<p>Our website may link to external sites that are not operated by us. Please be aware that we have no control over the content and policies of those sites, and cannot accept responsibility or liability for their respective privacy practices. </p>
<h3>Changes to This Policy</h3>
<p>At our discretion, we may change our privacy policy to reflect updates to our business processes, current acceptable practices, or legislative or regulatory changes. If we decide to change this privacy policy, we will post the changes here at the same link by which you are accessing this privacy policy. </p>
<p>If required by law, we will get your permission or give you the opportunity to opt in to or opt out of, as applicable, any new uses of your personal information. </p>
<h3>Contact Us</h3>
<p>For any questions or concerns regarding your privacy, you may contact us using the following details: </p>
<p>The Biofactoid Team<br />
info@biofactoid.org </p>
84 changes: 10 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
# Factoid

[![DOI](https://zenodo.org/badge/3910378.svg)](https://zenodo.org/badge/latestdoi/3910378)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/PathwayCommons/factoid/blob/unstable/LICENSE)

Biofactoid [(biofactoid.org)](https://biofactoid.org/), is a web-based system that empowers authors to capture and share machine-readable summaries of molecular-level interactions described in their publications.

Biofactoid's codebase is licensed under [MIT](LICENSE).

## Getting the data

All contributed pathway data is freely available for download at https://biofactoid.org/api/document/zip which contains files for each pathway represented in:
- JavaScript Object Notation (JSON). This is the native format for Biofactoid data and contains interaction data, metadata of the record itself, metadata of the corresponding article, and visualisation data (layout and colors as Cytoscape JSON (Franz et al. (2016) Bioinforma. Oxf. Engl., 32, 309–311.)).
- [Biological Pathway Exchange (BioPAX)](http://www.biopax.org/) (Demir et al. (2010) Biotechnol., 28, 935–942.) for detailed semantic exchange.
- [Systems Biology Graphical Notation Markup Language (SBGNML)](https://sbgn.github.io/), a format that supports biological process visualization (Le Novère et al. Nat. Biotechnol., 27, 735–741. (2009); van Iersel et al. (2012) Bioinforma. Oxf. Engl., 28, 2016–2021.)

Our data is licensed under [CC0](https://creativecommons.org/publicdomain/zero/1.0/legalcode).

## Required software

- [Node.js](https://nodejs.org/en/) >=10
Expand All @@ -32,6 +39,7 @@ CRON:
- `DOCUMENT_CRON_UPDATE_PERIOD_DAYS` : The minimum time between successive Document cron update calls
- `DOCUMENT_CRON_CREATED_AGE_DAYS` : Only Documents created fewer than this many days will be selecte for update. When undefined (default), ignores filtering on creation date.
- `DOCUMENT_CRON_REFRESH_ENABLED` : Flag to enable existing Document metadata to be refreshed (e.g. PubMed UID) (default true).
- `DOCUMENT_CRON_UNEDITED_DAYS` : Number of days since Documemt was last edited; criteria for trashing

Database:

Expand Down Expand Up @@ -149,80 +157,7 @@ The following environment variables should always be set in production instances

## Running via Docker

### Requirements

Dockerized system has been successfully deployed on:
- Ubuntu 16.04.5 LTS (GNU/Linux 4.4.0-145-generic x86_64)
- Docker version 19.03.12
- docker-compose version 1.26.2
- OSX 10.15.1 (Catalina)
- Docker version 19.03.12
- docker-compose version 1.26.2

### Docker Compose

In the directory containing the `docker-compose.yml` file, execute:

```sh
docker-compose up -d
```

Monitor stdout of the system:

```sh
docker-compose logs -ft
```

Stop and remove services:
```sh
docker-compose down
```

#### Notes

- Environment variables:
- Docker Compose will draw environment variables from the shell or from an `.env` file in the same directory. Please see private [remote](https://github.com/BaderLab/sysadmin/blob/master/websites/factoid.md) for production-level file settings.

- Database service:
- Do not restart a stopped container. Rather, remove and run anew.

- OS specifics:
- For Ubuntu 16.04.5 LTS to [play nice with elasticsearch](https://github.com/docker-library/elasticsearch/issues/111#issuecomment-268511769) needed to set `sudo sysctl -w vm.max_map_count=262144`.

### Dump and restore Rethinkdb data

NB: RethinkDB [dump and restore](https://rethinkdb.com/docs/backup/) command-line utility depends on the [Python driver](https://rethinkdb.com/docs/install-drivers/python/). The `docker/Dockerfile-rethinkdb` file documents these requirements.

#### Dump

To create an archive of data in RethinkDB, use the supplied bash script `/docker/dump_rethinkdb.sh`.

- The script accepts four arguments:
- `-c` (required) The container name
- `-e` (optional) Limit the dump to the given database and/or table; Use dot notation e.g. 'test.authors'
- `-n` (optional) The dump archive name; `.tar.gz` will be appended
- `-d` (optional) Output to the specified directory on the host; defaults to `pwd`

Example: To dump a running container `db_container` with database named `factoid` to an archive named `factoid_dump_latest` in a directory on the host named `/backups`:

```sh
./dump_rethinkdb.sh -c db_container -e factoid -n factoid_dump_latest -d /backups
```

#### Restore

To populate RethinkDB from an archive, use the supplied bash script `/docker/restore_rethinkdb.sh`.

- The script accepts three arguments:
- `-c` (required) The container name
- `-f` (required) Archive file path on host
- `-i` (optional) Limit the restore to the given database and/or table; Use dot notation e.g. 'test.authors'. By default, the script will overwrite any existing database/table data.

Example: To restore a running container `db_container` with database named `factoid` from an archive named `/backups/factoid_dump_latest.tar.gz`:

```sh
./restore_rethinkdb.sh -c db_container -f /backups/factoid_dump_latest.tar.gz -i factoid
```
Images are maintained at [dockerhub](https://hub.docker.com/repository/docker/pathwaycommons/factoid). Also see [factoid-docker-config](https://github.com/PathwayCommons/factoid-docker-config).

## Testing

Expand All @@ -247,6 +182,7 @@ Notes:
1. For a breaking API change, run `npm version major.`
1. For a specific version number (e.g. 1.2.3), run `npm version 1.2.3`.
1. Push the release: `git push origin --tags`
1. [Publish a GitHub release](https://github.com/PathwayCommons/factoid/releases/new) so that Zenodo creates a DOI for this version.

## Related software

Expand Down
33 changes: 0 additions & 33 deletions docker/.env

This file was deleted.

39 changes: 0 additions & 39 deletions docker/Dockerfile-rethinkdb

This file was deleted.

22 changes: 0 additions & 22 deletions docker/cron-database-dump.sh

This file was deleted.

69 changes: 0 additions & 69 deletions docker/docker-compose.yml

This file was deleted.

Loading