Initial OS commit

Author: Ian Lai

.gitignore

@@ -0,0 +1,9 @@
+build/
+logs
+*.log
+npm-debug.log*
+node_modules
+.npm
+.DS_STORE
+*.env
+!sample.env

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2016 Arachnys Information Services Ltd and individual contributors.
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Makefile

@@ -0,0 +1,44 @@
+CLI_DIR ?= cli
+CLI_IMAGE ?= "arachnysdocker/athenapdf"
+CLI_DOCKER_ARTIFACT_DIR ?= "/athenapdf/build/"
+
+SERVICE_DIR ?= weaver
+SERVICE_IMAGE ?= "arachnysdocker/athenapdf-service"
+SERVICE_DOCKER_ARTIFACT_FILE ?= "/go/src/github.com/arachnys/athenapdf/weaver"
+
+P="\\033[34m[+]\\033[0m"
+
+help:
+	@echo
+	@echo "  \033[34mbuildcli\033[0m – builds athenapdf (cli) docker image"
+	@echo "  \033[34mbuildservice\033[0m – builds athenapdf-service docker image"
+	@echo "  \033[34mbuild\033[0m – builds both the cli, and service docker image"
+	@echo
+
+buildcli:
+	@echo "  $(P) buildcli"
+	@rm -rf $(CLI_DIR)/build/
+	@docker build --rm -t $(CLI_IMAGE)-build -f $(CLI_DIR)/Dockerfile.build $(CLI_DIR)/
+	@docker run -t $(CLI_IMAGE)-build /bin/true
+	@docker cp `docker ps -q -n=1`:$(CLI_DOCKER_ARTIFACT_DIR) $(CLI_DIR)/build/
+	@docker rm -f `docker ps -q -n=1`
+	@docker build --rm -t $(CLI_IMAGE) -f $(CLI_DIR)/Dockerfile $(CLI_DIR)/
+	@rm -rf $(CLI_DIR)/build/
+
+buildservice:
+	@echo "  $(P) buildservice"
+	@rm -rf $(SERVICE_DIR)/build/
+	@docker build --rm -t $(SERVICE_IMAGE)-build -f $(SERVICE_DIR)/Dockerfile.build $(SERVICE_DIR)/
+	@docker run -t $(SERVICE_IMAGE)-build /bin/true
+	@docker cp `docker ps -q -n=1`:$(SERVICE_DOCKER_ARTIFACT_FILE) $(SERVICE_DIR)/build/
+	@docker rm -f `docker ps -q -n=1`
+	@chmod +x $(SERVICE_DIR)/build/weaver
+	@docker build --rm -t $(SERVICE_IMAGE) -f $(SERVICE_DIR)/Dockerfile $(SERVICE_DIR)/
+	@rm -rf $(SERVICE_DIR)/build/
+
+build:
+	@echo "  $(P) build"
+	@make buildcli
+	@make buildservice
+
+.PHONY: help buildcli buildservice build

README.md

@@ -0,0 +1,116 @@
+# Athena
+
+[Main Website][athenapdf]
+
+Simple, Docker-powered PDF conversions.
+
+Athena is comprised of an [Electron][electron] command line interface (CLI) tool, and a [Go][go] microservice for converting HTML to PDF documents.
+
+> Athena transformed Arachne into a spider for challenging her as a weaver and/or weaving a tapestry that insulted the gods.
+
+**Examples:**
+
+- Original: [Google isn’t even close as a tool for proper due diligence. Why not?][example-1] **(Converted: [PDF][example-1-pdf] | [Aggressive][example-1-aggressive])**
+- Original: [Panamanian Law Firm Is Gatekeeper To Vast Flow of Murky Offshore Secrets][example-2] **(Converted: [PDF][example-2-pdf] | [Aggressive][example-2-aggressive])**
+
+_When [aggressive mode][aggressive] is toggled, only the essential contents of a page are kept in the generated PDF document. It is a clutter-free version of the web page, perfect for reading._
+
+**HTML, PDF, PDF (Aggressive):**
+
+![Conversion](https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/conversion.gif)
+
+
+## Background
+
+Athena is an open source project.
+
+It was designed to [do one thing and to do it well][unixphil] - PDF conversions; to work together with other programs; and to be able to handle text streams, because that is a universal interface.
+
+It aims to empower individuals, and organisations with an on-demand capability to convert HTML to PDF without frills.
+
+At the lowest level, its [CLI][cli] component ([`athenapdf`][cli]) was designed to be an alternative / drop-in replacement for [wkhtmltopdf], a popular CLI tool for HTML to PDF conversions.
+
+There is also a [microservice][weaver] component ([`weaver`][weaver]), and it was designed to be an alternative / drop-in replacement for paid services like [CloudConvert][cloudconvert], but with more freedom, and flexibility, and without limitations, long support response times, and price plans.
+
+
+## Getting Started
+
+### CLI vs Microservice
+
+Our [CLI][cli] tool will suffice for most simple, and everyday HTML to PDF conversions.
+
+However, for conversions at scale / PDF conversion as a service, we recommend getting started with our [microservice][weaver] component instead.
+
+![CLI vs Microservice](https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/docker.png)
+
+The microservice is packaged with `athenapdf`, and you can run both components independently.
+
+### Docker
+
+Both components are packaged, and distributed as [Docker][docker] images.
+
+The only dependency you will need is Docker, and the rest will be handled for you (even if you are running in an environment without a display server - [headless environment][headless]).
+
+### Quick Start
+
+Before starting, ensure your [Docker][docker] environment is set up, and ready-to-use.
+
+**For OSX / Windows users**, ensure your [Docker Machine][docker-machine] is prepared, and the appropriate environment variables are established.
+
+#### CLI
+
+[![asciicast](https://asciinema.org/a/c1fbvtdnrctfq6baipfox00ct.png)](https://asciinema.org/a/c1fbvtdnrctfq6baipfox00ct)
+
+1. `docker pull arachnysdocker/athenapdf`
+2. `docker run --rm -v $(pwd):/converted/ arachnysdocker/athenapdf athenapdf <input_path> [output_path]`
+3. See [`cli`][cli] for full documentation
+
+The `[output_path]` can be omitted.
+
+Example: `docker run --rm -v $(pwd):/converted/ arachnysdocker/athenapdf athenapdf http://blog.arachnys.com/`
+
+#### Microservice
+
+[![asciicast](https://asciinema.org/a/41247.png)](https://asciinema.org/a/41247)
+
+1. `docker pull arachnysdocker/athenapdf-service`
+2. `docker run -p 8080:8080 --rm arachnysdocker/athenapdf-service`
+3. Inline conversion: `http://<docker-address>:8080/convert?auth=arachnys-weaver&url=http://blog.arachnys.com/`
+4. OR cURL, and redirect output to file: `curl http://dockerhost:8080/convert\?auth\=arachnys-weaver\&url\=http://blog.arachnys.com/ |> out.pdf`
+5. See [`weaver`][weaver] for full documentation
+
+The default authentication key is `arachnys-weaver`. This can be changed through the `WEAVER_AUTH_KEY` environment variable.
+
+
+## License
+
+Please note `athenapdf` is NEITHER affiliated with NOR endorsed by Google Inc. and GitHub Inc.
+
+See [`LICENSE`](LICENSE).
+
+---
+
+![Arachnys](https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/logo.png)
+
+An [Arachnys][arachnys] Christmas project.
+
+
+[athenapdf]: http://www.athenapdf.com/
+[unixphil]: https://en.wikipedia.org/wiki/Unix_philosophy
+[example-1]: http://blog.arachnys.com/google-isnt-even-close-to-proper-due-diligence.-why-not?utm_campaign=athena&utm_medium=external%20website&utm_source=github&utm_content=readme
+[example-1-pdf]: https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/d0ae9e636bb7edceac48bd9b0780ad9dd69397cc.pdf
+[example-1-aggressive]: https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/d0ae9e636bb7edceac48bd9b0780ad9dd69397cc-aggressive.pdf
+[example-2]: https://panamapapers.icij.org/20160403-mossack-fonseca-offshore-secrets.html
+[example-2-pdf]: https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/f86e19ea13661e47c1f5f83bbde650eb3fe85aad.pdf
+[example-2-aggressive]: https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/f86e19ea13661e47c1f5f83bbde650eb3fe85aad-aggressive.pdf
+[aggressive]: cli/docs/aggressive.md
+[electron]: http://electron.atom.io/
+[go]: https://golang.org/
+[cli]: cli/
+[weaver]: weaver/
+[wkhtmltopdf]: http://wkhtmltopdf.org/
+[cloudconvert]: https://cloudconvert.com/
+[docker]: https://www.docker.com/
+[docker-machine]: https://docs.docker.com/mac/step_one/
+[headless]: http://internetofthingsagenda.techtarget.com/definition/headless-system
+[arachnys]: https://www.arachnys.com/?utm_campaign=athena&utm_medium=external%20website&utm_source=github&utm_content=readme

cli/.dockerignore

@@ -0,0 +1,18 @@
+# Node
+node_modules/
+bin/
+
+# Docker
+.dockerfile
+docker-compose.yml
+Dockerfile
+Dockerfile.build
+
+# Docs
+README.md
+docs/
+
+# Others
+**/.DS_STORE
+**/.git*
+**/*.env

cli/Dockerfile

@@ -0,0 +1,38 @@
+FROM debian:8.3
+MAINTAINER Arachnys <[email protected]>
+
+RUN echo 'deb http://debian.man.ac.uk/debian/ stable main contrib non-free' >> /etc/apt/sources.list
+
+RUN apt-get -yq update && \
+    apt-get -yq install \
+        xvfb \
+        libgtk2.0-0 \
+        libgconf-2-4 \
+        libXtst6 \
+        libnss3 \
+        libnotify4 \
+        ttf-mscorefonts-installer \
+        ttf-liberation \
+        ttf-wqy-zenhei \
+        ttf-unfonts-core \
+        fonts-sil-padauk \
+        fonts-lklug-sinhala \
+        fonts-thai-tlwg \
+    && apt-get -yq autoremove \
+    && apt-get -yq clean \
+    && rm -rf /var/lib/apt/lists/* \
+    && truncate -s 0 /var/log/*log
+
+ADD build/athenapdf-linux-x64/ /athenapdf/
+WORKDIR /athenapdf/
+
+ENV PATH /athenapdf/:$PATH
+
+ADD entrypoint.sh /athenapdf/entrypoint.sh
+
+RUN mkdir -p /converted/
+WORKDIR /converted/
+
+CMD ["athenapdf"]
+
+ENTRYPOINT ["/athenapdf/entrypoint.sh"]

cli/Dockerfile.build

@@ -0,0 +1,17 @@
+FROM mhart/alpine-node:5.9.1
+MAINTAINER Arachnys <[email protected]>
+
+RUN mkdir -p /athenapdf/build/artifacts/
+WORKDIR /athenapdf/
+
+ADD package.json /athenapdf/
+RUN npm install
+
+ADD package.json /athenapdf/build/artifacts/
+RUN cp -r /athenapdf/node_modules/ /athenapdf/build/artifacts/
+
+ADD src /athenapdf/build/artifacts/
+RUN sed -i "1s/^/process.argv.unshift(\"--\");\n /" /athenapdf/build/artifacts/athenapdf.js
+RUN npm run build:linux
+
+CMD ["/bin/sh"]