Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rhizome-conifer/conifer
Collect and revisit web pages.
https://github.com/rhizome-conifer/conifer
archives docker python pywb warc wayback web-archiving webrecorder
Last synced: 23 days ago
JSON representation
Collect and revisit web pages.
- Host: GitHub
- URL: https://github.com/rhizome-conifer/conifer
- Owner: Rhizome-Conifer
- License: apache-2.0
- Created: 2015-05-13T19:27:29.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-08T17:14:03.000Z (12 months ago)
- Last Synced: 2024-05-18T11:10:47.293Z (6 months ago)
- Topics: archives, docker, python, pywb, warc, wayback, web-archiving, webrecorder
- Language: Python
- Homepage: https://conifer.rhizome.org
- Size: 25.5 MB
- Stars: 1,458
- Watchers: 52
- Forks: 117
- Open Issues: 126
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Conifer
### Collect and revisit web pages.
Conifer provides an integrated platform for creating high-fidelity, ISO-compliant web archives in a user-friendly interface, providing access to archived content, and sharing collections.
This repository represents the hosted service running at https://conifer.rhizome.org/, which can also be [deployed locally using Docker](#running-locally)
This README refers to the 5.x version of Conifer, released in June, 2020. This release includes a new UI and the renaming of Webrecorder.io to Conifer. Other parts of the open source efforts remain at the [Webrecorder Project](https://webrecorder.net). For more info about this momentous change, read our announcement [blog post.](https://blog.conifer.rhizome.org/2020/06/11/webrecorder-conifer.html)
The previous UI is available on the [legacy branch](https://github.com/Rhizome-Conifer/conifer/tree/legacy).
## Frequently asked questions
* If you have any questions about how to use Conifer, please see our [User Guide](https://guide.conifer.rhizome.org).
* If you have a question about your account on the hosted service (conifer.rhizome.org), please contact us via email at [[email protected]](mailto:[email protected])
* If you have a previous Conifer installation (version 3.x), see [Migration Info](migrating-4.0.md) for instructions on how to migrate to the latest version.
## Using the Conifer Platform
Conifer and related tools are designed to make web archiving more portable and decentralized, as well as to serve users and developers with a broad range of skill levels and requirements. Here are a few ways that Conifer can be used (starting with what probably requires the least technical expertise).
### 1. Hosted Service
Using our hosted version of Conifer at https://conifer.rhizome.org/, users can sign up for a free account and create their own personal collections of web archives. Captures web content will be available online, either publicly or only privately, under each user account, and can be downloaded by the account owner at any time. Downloaded web archives are available as WARC files. (WARC is the ISO standard file format for web archives.) The hosted service can also be used anonymously and the captured content can be downloaded at the end of a temporary session.
### 2. Offline Capture and Browsing
The Webrecorder Project is a closely aligned effort that offers OSX/Windows/Linux Electron applications:
* [Webrecorder Player](https://github.com/webrecorder/webrecorder-player) browse WARCs created by Webrecorder (and other web archiving tools) locally on the desktop.
* [Webrecorder Desktop](https://github.com/webrecorder/webrecorder-desktop) a desktop version of the hosted Webrecorder service providing both capture and replay features.
### 3. Preconfigured Deployment
To deploy the full version of Conifer with Ansible on a Linux machine, the [Conifer Deploy](https://github.com/rhizome-conifer/conifer-deploy) workbook can be used to install this repository, configure nginx and other dependencies, such as SSL (via Lets Encrypt). The workbook is used for the https://conifer.rhizome.org deployment.
### 4. Full Conifer Local Deployment
The Conifer system in this repository can be deployed directly by [following the instructions below](#running-locally).
Conifer runs entirely in Docker and also requires Docker Compose.
### 5. Standalone Python Wayback (pywb) Deployment
Finally, for users interested in the core "replay system" and very basic recording capabilities, deploying [pywb](https://github.com/webrecorder/pywb) could also make sense. Conifer is built on top of pywb (Python Wayback/Python Web Archive Toolkit), and the core recording and replay functionality is provided by pywb as a standalone Python library. pywb comes with a Docker image as well.
pywb can be used to deploy your own web archive access service. See the [full pywb reference manual](http://pywb.readthedocs.org/) for further information on using and deploying pywb.
## Running Locally
Conifer can be run on any system that has [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed. To install manually, clone
1. `git clone https://github.com/rhizome-conifer/conifer`
2. `cd conifer; bash init-default.sh`.
3. `docker-compose build`
4. `docker-compose up -d`
(The `init-default.sh` is a convenience script that copies [wr_sample.env](webrecorder/webrecorder/config/wr_sample.env) → `wr.env` and creates keys for session encryption.)
Point your browser to `http://localhost:8089/` to access the locally running Conifer instance.
(Note: you may see a maintenance message briefly while Conifer is starting up. Refresh the page after a few seconds to see the Conifer home page).
### Installing Remote Browsers
Remote Browsers are standard browsers like Google Chrome and Mozilla Firefox, encapsulated in Docker containers. This feature allows Conifer to directly use fixed versions of browsers for capturing and accessing web archives, with a more direct connection to the live web and web archives. Remote browsers in many cases can improve the quality of web archives during capture and access. They can be "remote controlled" by users and are launched as needed, and use the same amount of computing and memory resources as they would when just running as regular desktop apps.
Remote Browsers are optional, and can be installed as needed.
Remote Browsers are just Docker images which start with `oldweb-today/`, and are part of
[oldweb-today](https://github.com/oldweb-today/) organization on GitHub.
Installing the browsers can be as simple as running `docker pull` on each browser image each as well as
additional Docker images for the Remote Desktop system.
To install the Remote Desktop System and all of the officially supported Remote Browsers, run [install-browsers.sh](install-browsers.sh)
### Configuration
Conifer reads its configuration from two files: `wr.env`, and less-commonly changed system settings in `wr.yaml`.
The `wr.env` file contains numerous deployment-specific customization options. In particular, the following options may be useful:
#### Host Names
By default, Conifer assumes its running on localhost or a single domain, but on different ports for application (the Conifer user interface) and content (material rendered from web archives). This is a security feature preventing archived web sites accessing and possibly changing Conifer's user interface, and other unwanted interactions.
To run Conifer on different domains, the `APP_HOST` and `CONTENT_HOST` environment variables should be set.
For best results, the two domains should be two subdomains, both with https enabled.
The `SCHEME` env var should also be set to `SCHEME=https` when deploying via https.
#### Anonymous Mode
By default Conifer disallows anonymous recording. To enable this feature, set ANON_DISABLED=false to the wr.env file and restart.
*Note: Previously the default setting was anonymous recording enabled (`ANON_DISABLED=false`)*
#### Storage
Conifer uses the `./data/` directory for local storage, or an external backend, currently supporting S3.
The `DEFAULT_STORAGE` option in `wr.env` configures storage options, which can be `DEFAULT_STORAGE=local` or `DEFAULT_STORAGE=s3`
Conifer uses a temporary storage directory for data while it is actively being captured, and temporary collections. Data is moved into the 'permanent' storage when the capturing process is completed or a temporary collection is imported into a user account.
The temporary storage directory is: `WARCS_DIR=./data/warcs`.
The permanent storage directory is either `STORAGE_DIR=./data/storage` or local storage.
When using s3, the value of `STORAGE_DIR` is ignored and data gets placed into `S3_ROOT` which is an `s3://` bucket URL.
Additional s3 auth environment settings must also be set in `wr.env` or externally.
All data related to Conifer that is not web archive data (WARC and CDXJ) is stored in the Redis instance, which persists data to `./data/dump.rdb`. (See [Conifer Architecture](#conifer-architecture) below.)
#### Email
Conifer can send confirmation and password recovery emails. By default, a local SMTP server is run in Docker, but can be configured to use a remote server by changing the environment variables `EMAIL_SMTP_URL` and `EMAIL_SMTP_SENDER`.
#### Frontend Options
The react frontend includes a number of additional options useful for debugging. Setting `NODE_ENV=development` will switch react to development mode with hot reloading on port 8096.
Additional frontend configuration can be found in [frontend/src/config.js](frontend/src/config.js)
### Administration tool
The script `admin.py` provides easy low level management of users. Adding, modifying, or removing users can be done via the command line.
To interactively create a user:
```sh
docker exec -it app python -m webrecorder.admin -c
```
or programmatically add users by supplying the appropriate positional values:
```sh
docker exec -it app python -m webrecorder.admin \
-c ''
```
Other arguments:
* `-m` modify a user
* `-d` delete a user
* `-i` create and send a new invite
* `-l` list invited users
* `-b` send backlogged invites
See `docker exec -it app python -m webrecorder.admin --help` for full details.
### Restarting Conifer
When making changes to the Conifer backend app, running
```sh
docker-compose kill app; docker-compose up -d app
```
will stop and restart the container.
To integrate changes to the frontend app, either set `NODE_ENV=development` and utilize hot reloading. If you're running production (`NODE_ENV=production`), run
```sh
docker-compose kill frontend; docker-compose up -d frontend
```
To fully recreate Conifer, deleting old containers (but not the data!) use the `./recreate.sh` script.
## Conifer Architecture
This repository contains the Docker Compose setup for Conifer, and is the exact system deployed on https://conifer.rhizome.org. The full setup consists of the following components:
- `/app` - The Conifer backend system includes the API, recording and WARC access layers, split into 3 containers:
- `app` -- The API and data model and rewriting system are found in this container.
- `recorder` -- The WARC writer is found in this container.
- `warcserver` -- The WARC loading and lookup is found in this container.
The backend containers run different tools from [pywb](https://github.com/webrecorder/pywb), the core web archive replay toolkit library.
- `/frontend` - A React-based frontend application, running in Node.js. The frontend is a modern interface for Conifer and uses the backend api. All user access goes through frontend (after nginx).
- `/nginx` - A custom nginx deployment to provide routing and caching.
- `redis` - A Redis instance that stores all of the Conifer state (other than WARC and CDXJ).
- `dat-share` - An experimental component for sharing collections via the [Dat protocol](https://datproject.org/)
- `shepherd` - An instance of [OldWebToday Browser Shepherd](https://github.com/oldweb-today/browsers) for managing remote browsers.
- `mailserver` - A simple SMTP mail server for sending user account management mail
- `behaviors` - Custom [automation behaviors](https://github.com/webrecorder/behaviors)
- `browsertrix` - Automated [crawling system](https://github.com/webrecorder/browsertrix)
### Dependencies
Conifer is built using both Python (for backend) and Node.js (for frontend) using a variety of Python and Node open source libraries.
Conifer relies on a few separate repositories in this organization:
- [pywb](https://github.com/webrecorder/pywb)
- [warcio](https://github.com/webrecorder/warcio)
- [har2warc](https://github.com/webrecorder/har2warc)
- [public-web-archives](https://github.com/webrecorder/public-web-archives)
- [dat-share](https://github.com/webrecorder/dat-share)
The remote browser system uses https://github.com/oldweb-today/ repositories, including:
- [browsers](https://github.com/oldweb-today/browsers)
- [browser-chrome](https://github.com/oldweb-today/browser-chrome)
- [browser-firefox](https://github.com/oldweb-today/browser-firefox)
### Contact
Conifer is a project of [Rhizome](https://rhizome.org), made possible with generous past support from the Andrew W. Mellon Foundation.
For more info on using Conifer, you can consult our user guide at: https://guide.conifer.rhizome.org
For any general questions/concerns regarding the project or https://conifer.rhizome.org you can:
* Open [issues](https://github.com/rhizome-conifer/conifer/issues) on GitHub
* Tweet to us at https://twitter.com/rhizomeconifer
* Contact us at [email protected]
### License
Conifer is Licensed under the Apache 2.0 License. See [NOTICE](NOTICE) and [LICENSE](LICENSE) for details.