https://github.com/buren/wayback_archiver_saas
Wayback Archiver - SAAS
https://github.com/buren/wayback_archiver_saas
rails wayback-archiver wayback-machine
Last synced: 3 months ago
JSON representation
Wayback Archiver - SAAS
- Host: GitHub
- URL: https://github.com/buren/wayback_archiver_saas
- Owner: buren
- Created: 2017-08-06T00:24:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-29T12:30:03.000Z (over 3 years ago)
- Last Synced: 2025-01-20T04:18:59.239Z (5 months ago)
- Topics: rails, wayback-archiver, wayback-machine
- Language: Ruby
- Homepage: http://api.waybackarchiver.com
- Size: 50.8 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Wayback Archiver - SAAS
Wayback Archiver - Software as a Service (SAAS)
__Built with__:
* Ruby v2.4
* PostgreSQL > 9.3
* Redis > 3
Sidekiq UI @ `/sidekiq`.
## API
### Create archivation
_Required_: `url`.
_Optional_: `strategy`, `notification_email`.
#### `GET /ping?sitemap=http://example.com`
Also supports `notification_email` param.
#### `POST /archivations/`
_Payload_:
```json
{
"archivation": {
"url": "http://example.com",
"strategy": "crawl",
"notification_email": "[email protected]"
}
}
```
_Response success_:
```json
{
"id": 32,
"url": "http://example.com",
"strategy": "crawl",
"status": "queued",
"notification_email": "[email protected]",
"created_at": "2017-08-05T23:56:51.905Z",
"updated_at": "2017-08-05T23:56:51.905Z"
}
```
_Response error_:
```json
{
"status": 422,
"errors": [
"Url to soon for URL resubmission please try again at 2017-08-06 23:41:17 UTC (~24 hours)"
]
}
```
### Show archivation
#### `GET /archivations/:uuid`
_Response success_:
```json
{
"id": 32,
"url": "http://example.com",
"strategy": "crawl",
"status": "queued",
"notification_email": "[email protected]",
"created_at": "2017-08-05T23:56:51.905Z",
"updated_at": "2017-08-05T23:56:51.905Z"
}
```
_Response error_: 404
## Configuration
Env. variables
* `ADMIN_EMAIL` - Admin email
* `ADMIN_PASSWORD` - Admin password
* `WAYBACK_ARCHIVER_DEFAULT_MAX_LIMIT` - WaybackArchiver Max URLs to be sent by default
* `WAYBACK_ARCHIVER_CONCURRENCY` - WaybackArchiver default concurrency
* `SENDGRID_USERNAME` - Sendgrid username
* `SENDGRID_PASSWORD` - Sendgrid password
* `DEFAULT_FROM_EMAIL` - Default mailer from email address
* `REDIS_URL` - Redis URL
## Deployment
```
$ heroku create
$ git push heroku master
$ heroku run rails db:migrate
$ heroku addons:create heroku-redis:hobby-dev
$ heroku addons:create sendgrid:starter
```