├── .dockerignore ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── build.sh └── docker-provision.sh /.dockerignore: -------------------------------------------------------------------------------- 1 | # .dockerignore --- Configures files to exclude from the generated Docker image. 2 | .git 3 | .dockerignore 4 | .gitignore 5 | Dockerfile 6 | LICENSE 7 | README.md 8 | build.sh 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # .gitignore --- Configures files to ignore from this Git repository. 2 | 3 | # -------------------- 4 | # IDE Cruft 5 | # -------------------- 6 | .classpath 7 | .project 8 | .settings 9 | *.iml 10 | .idea 11 | nbproject 12 | nb-configuration.xml 13 | nbactions.xml 14 | 15 | 16 | # -------------------- 17 | # Misc. 18 | # -------------------- 19 | .DS_Store 20 | *~ 21 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:6-slim 2 | 3 | ADD docker-provision.sh /tmp/ 4 | RUN cd /tmp/ && sh docker-provision.sh 5 | 6 | WORKDIR /docs 7 | 8 | # run GitBook when the container starts 9 | ENTRYPOINT ["gitbook"] 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | 118 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gitbook-docker 2 | 3 | [GitBook](https://github.com/GitbookIO/gitbook) installed in a Docker container. 4 | 5 | This image can be used to build books with the GitBook CLI. 6 | 7 | > NOTE: The image is created with the current version of GitBook installed at the time the image was created. You can add a different version, but beware that by default the GitBook CLI installs GitBook versions in $HOME (i.e. `/root` with the current configuration), which will disappear when the container is shutdown unless you map it to a local directory. 8 | 9 | 10 | ## Usage 11 | 12 | ### Use Case #1: Generating HTML 13 | 14 | To run gitbook with the current directory mounted to `/docs`: 15 | 16 | $ docker run -ti --rm -v `pwd`:/docs humangeo/gitbook 17 | 18 | 19 | ### Use Case #2: Building a PDF 20 | 21 | $ docker run -ti --rm -v `pwd`:/docs humangeo/gitbook pdf 22 | -------------------------------------------------------------------------------- /build.sh: -------------------------------------------------------------------------------- 1 | docker build -t humangeo/gitbook . 2 | -------------------------------------------------------------------------------- /docker-provision.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh -eux 2 | # docker-provision.sh --- Provisioning script for a Docker container w/GitBook. 3 | GITBOOK_CLI_VERSION="2.3.0" 4 | 5 | # update Apt repositories 6 | apt-get update 7 | 8 | # install dependencies 9 | apt-get install -y --no-install-recommends git calibre 10 | 11 | # install GitBook CLI 12 | npm install -g gitbook-cli@$GITBOOK_CLI_VERSION 13 | 14 | # install the latest version...gets installed in $HOME (i.e. /root) 15 | gitbook fetch latest 16 | 17 | # add gitbook wrapper script 18 | cat < /usr/local/bin/gitbookw 19 | #!/bin/sh -eu 20 | # gitbookw --- Wrapper for gitbook that autoinstalls plugins. 21 | 22 | gitbook install 23 | gitbook \$@ 24 | EOF 25 | chmod +x /usr/local/bin/gitbookw 26 | 27 | # clean up (apt) 28 | apt-get clean # remove packages that have been downloaded, installed, and no longer needed 29 | apt-get autoclean # remove archived packages that can no longer be downloaded 30 | apt-get autoremove 31 | 32 | # clean up (misc.) 33 | rm -rf /var/lib/apt/lists/* /var/cache/apt/* /root/.npm /tmp/npm* 34 | 35 | # Add empty docs directory 36 | mkdir -p /docs 37 | --------------------------------------------------------------------------------