This project provides an example test for deploying WARC (Web ARChive) files using GitHub Pages and ReplayWeb.page to make archived web content accessible online.
- Overview: Demonstrate a simple solution to host and access WARC files for public browsing using GitHub Pages as part of an example test.
- Version: 1.0.0
- Host WARC files publicly on GitHub Pages.
- Utilise ReplayWeb.page to enable seamless browsing of archived content.
- Easy setup and configuration tailored for non-technical users.
- Homebrew: Latest version
- Python: 3.x
- wget: Latest version
- Git: Latest version
- GitHub Account
- Internet Access
- Install
wgetusing Homebrew:brew install wget
- Clone the repository:
git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.git
- Local Server Setup: Use Python to host your local files.
- WARC Capture: Capture your site into a WARC file using
wget. - GitHub Pages Setup: Configure your repository settings to enable Pages.
- Database configuration: Not applicable
- CMS/Static Site Setup: Ensure your local static site is ready.
- Environment Variables: Not required
- Development: http://localhost:8000
- Testing: This is part of an example test, not applicable.
- Staging: Not applicable
- Production: Your GitHub Pages URL (e.g.,
https://yourusername.github.io/yourrepository)
- Testing: Use local server environment to ensure all content is captured correctly. This is an example test scenario.
- Deployment: Push your WARC and HTML setup to GitHub and enable GitHub Pages.
- Writing tests: Ensure local server and capture process are correctly configured.
- Code reviews: Collaborate via GitHub issues and pull requests.
- Developed and maintained by RMIT University Library Digital Learning Team.
Licensed under MIT Licence.
- Karl Ervine (karl.ervine@rmit.edu.au)
- Repo Admin: Jack Dunstan (jack.dunstan@rmit.edu.au)
- Additional Contact: digital.learning.library@rmit.edu.au