├── Procfile ├── setup.sh ├── nginx.conf ├── README.md ├── Dockerfile └── LICENSE /Procfile: -------------------------------------------------------------------------------- 1 | ckb: ckb run -C /data/ckb-data 2 | openresty: openresty -g "daemon off;" -c /data/confs/nginx.conf 3 | -------------------------------------------------------------------------------- /setup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -ex 3 | 4 | [ -d /data/ckb-data ] || ckb init -c $CKB_NETWORK -C /data/ckb-data 5 | if [ ! -d /data/confs ]; then 6 | cp -r /confs /data/confs 7 | 8 | if [ "$ENABLE_RATE_LIMIT" == "true" ]; then 9 | sed -i s/@INDEXER_RPC_RATE/$INDEXER_RPC_RATE/ /data/confs/nginx.conf 10 | sed -i s/@RPC_RATE/$RPC_RATE/ /data/confs/nginx.conf 11 | else 12 | sed -i /limit_req/d /data/confs/nginx.conf 13 | fi 14 | 15 | if [ "$ENABLE_INDEXER" == "true" ]; then 16 | echo "indexer: ckb-indexer -s /data/indexer_db" >> /data/confs/Procfile 17 | fi 18 | fi 19 | -------------------------------------------------------------------------------- /nginx.conf: -------------------------------------------------------------------------------- 1 | worker_processes 2; 2 | 3 | events { 4 | worker_connections 1024; 5 | } 6 | 7 | http { 8 | include /etc/openresty/mime.types; 9 | default_type application/json; 10 | 11 | sendfile on; 12 | keepalive_timeout 65; 13 | 14 | upstream ckb_rpc { 15 | server 127.0.0.1:8114; 16 | } 17 | limit_req_zone $binary_remote_addr zone=rpc_limit:10m rate=@RPC_RATEr/s; 18 | 19 | upstream ckb_indexer_rpc { 20 | server 127.0.0.1:8116; 21 | } 22 | limit_req_zone $binary_remote_addr zone=indexer_rpc_limit:10m rate=@INDEXER_RPC_RATEr/s; 23 | 24 | server { 25 | listen 9115; 26 | server_name localhost; 27 | 28 | location = /status { 29 | access_log off; 30 | return 200 "OK\n"; 31 | } 32 | 33 | location = / { 34 | limit_req zone=rpc_limit burst=2; 35 | proxy_pass http://ckb_rpc; 36 | } 37 | 38 | location = /rpc { 39 | limit_req zone=rpc_limit burst=5; 40 | proxy_pass http://ckb_rpc; 41 | } 42 | 43 | location = /indexer_rpc { 44 | limit_req zone=indexer_rpc_limit burst=5; 45 | proxy_pass http://ckb_indexer_rpc; 46 | } 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Perkins' Tent 2 | ============= 3 | 4 | Reference: https://harrypotter.fandom.com/wiki/Perkins%27s_tent 5 | 6 | This repository provides a docker image containing the following pieces: 7 | 8 | * [ckb](https://github.com/nervosnetwork/ckb) 9 | * [ckb-indexer](https://github.com/quake/ckb-indexer) 10 | * [OpenResty](https://github.com/openresty/openresty) which reverse-proxies and rate-limits CKB RPC. 11 | 12 | The idea is that anyone can create a server with the docker image which serves CKB to the general public. 13 | 14 | While right now we are providing only basic setups, we might expand this later with more features such as: 15 | 16 | * Rate-limiting configurations 17 | * Token-based ACL 18 | 19 | # Usage 20 | 21 | To start the docker image, you can use the following command: 22 | 23 | ```bash 24 | $ docker run --rm -p 9115:9115 xxuejie/perkins-tent 25 | ``` 26 | 27 | Right now the image hardcodes port `9115` as the port to listen to, we might revise this later to make it configurable. That said, you can tweak docker's mapping port to listen at other ports. For example, the following command changes the image to listen at port `12345` instead of `9115`: 28 | 29 | ```bash 30 | $ docker run --rm -p 12345:9115 xxuejie/perkins-tent 31 | ``` 32 | 33 | It's also possible to preserve CKB's data as well as configuration file, the following command maps `/foo/bar` on the host machine into the docker image, so data and configurations can be reused across docker restarts: 34 | 35 | ```bash 36 | $ docker run --rm -p 9115:9115 -v /foo/bar:/data xxuejie/perkins-tent 37 | ``` 38 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM rust:1.41 as builder 2 | MAINTAINER Xuejie Xiao 3 | 4 | RUN apt-get update 5 | RUN apt-get -y install --no-install-recommends llvm-dev clang libclang-dev 6 | 7 | RUN git clone https://github.com/quake/ckb-indexer /ckb-indexer 8 | RUN cd /ckb-indexer && git checkout 60d397cf0d3e79f8d82f1e996644d870b1493401 && cargo build --release 9 | 10 | FROM debian:buster 11 | MAINTAINER Xuejie Xiao 12 | 13 | RUN apt-get update 14 | RUN apt-get -y install --no-install-recommends wget gnupg ca-certificates unzip software-properties-common 15 | RUN wget -O - https://openresty.org/package/pubkey.gpg | apt-key add - 16 | RUN add-apt-repository -y "deb http://openresty.org/package/debian $(lsb_release -sc) openresty" 17 | RUN apt-get update 18 | RUN apt-get -y install --no-install-recommends openresty libssl1.1 19 | 20 | COPY --from=builder /ckb-indexer/target/release/ckb-indexer /bin/ckb-indexer 21 | 22 | RUN wget https://github.com/nervosnetwork/ckb/releases/download/v0.38.1/ckb_v0.38.1_x86_64-unknown-linux-gnu.tar.gz -O /tmp/ckb_v0.38.1_x86_64-unknown-linux-gnu.tar.gz 23 | RUN cd /tmp && tar xzf ckb_v0.38.1_x86_64-unknown-linux-gnu.tar.gz 24 | RUN cp /tmp/ckb_v0.38.1_x86_64-unknown-linux-gnu/ckb /bin/ckb 25 | 26 | RUN mkdir /tmp/goreman && wget https://github.com/mattn/goreman/releases/download/v0.3.4/goreman_linux_amd64.zip -O /tmp/goreman/goreman_linux_amd64.zip 27 | RUN cd /tmp/goreman && unzip goreman_linux_amd64.zip 28 | RUN cp /tmp/goreman/goreman /bin/goreman 29 | 30 | RUN wget https://github.com/Yelp/dumb-init/releases/download/v1.2.2/dumb-init_1.2.2_amd64.deb -O /tmp/dumb-init.deb 31 | RUN dpkg -i /tmp/dumb-init.deb 32 | 33 | RUN rm -rf /tmp/ckb_v0.38.1_x86_64-unknown-linux-gnu/ckb /tmp/goreman /tmp/dumb-init.deb 34 | RUN apt-get -y remove wget gnupg ca-certificates unzip software-properties-common && apt-get -y autoremove && apt-get clean 35 | 36 | ENV ENABLE_RATE_LIMIT true 37 | ENV RPC_RATE 2 38 | ENV INDEXER_RPC_RATE 5 39 | 40 | ENV ENABLE_INDEXER true 41 | 42 | ENV CKB_NETWORK mainnet 43 | 44 | RUN mkdir /data 45 | RUN mkdir /confs 46 | COPY nginx.conf /confs/nginx.conf 47 | COPY setup.sh /confs/setup.sh 48 | COPY Procfile /confs/Procfile 49 | 50 | # CKB network port 51 | EXPOSE 8115 52 | # OpenResty port 53 | EXPOSE 9115 54 | 55 | ENTRYPOINT ["/usr/bin/dumb-init", "--"] 56 | CMD ["bash", "-c", "/confs/setup.sh && exec goreman -set-ports=false -exit-on-error -f /data/confs/Procfile start"] 57 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------