From 3170f5bba2fb85d8d8b7f9db52fb1f211b4a4225 Mon Sep 17 00:00:00 2001 From: Kohei Watanabe Date: Mon, 11 Jul 2022 19:32:49 +0900 Subject: [PATCH] create nttr.fly.dev project --- .github/workflows/deploy.yml | 13 ++++ Dockerfile | 6 ++ LICENSE | 121 +++++++++++++++++++++++++++++++++++ README.md | 19 ++++++ compose.yml | 12 ++++ entrypoint.sh | 4 ++ fly.toml | 26 ++++++++ nitter.example.conf | 48 ++++++++++++++ renovate.json | 10 +++ 9 files changed, 259 insertions(+) create mode 100644 .github/workflows/deploy.yml create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 README.md create mode 100644 compose.yml create mode 100755 entrypoint.sh create mode 100644 fly.toml create mode 100644 nitter.example.conf create mode 100644 renovate.json diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..db41592 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,13 @@ +name: deploy +on: + push: + branches: [main] +jobs: + main: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: superfly/flyctl-actions/setup-flyctl@master + - run: flyctl deploy --local-only + env: + FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..d9046f9 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,6 @@ +FROM zedeus/nitter:latest +RUN apk --no-cache add gettext +COPY entrypoint.sh nitter.example.conf / +WORKDIR /src +ENTRYPOINT ["/entrypoint.sh"] +CMD ["/bin/sh", "-c", "./nitter"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b402530 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# nttr.fly.dev + +## 前提 + +- Redis + +## 構築 + +```sh +git clone git@github.com:kou029w/nttr.fly.dev.git +curl -L https://fly.io/install.sh | sh +flyctl auth login +flyctl launch --no-deploy +flyctl secrets set REDIS_HOST=redis # Redis接続情報を設定 +flyctl secrets set REDIS_PORT=6379 # Redis接続情報を設定 +flyctl secrets set REDIS_PASSWORD=*** # Redis接続情報を設定 +flyctl secrets set "SECRET_KEY=$(python3 -c 'import secrets; print(secrets.token_urlsafe())')" +flyctl deploy --local-only +``` diff --git a/compose.yml b/compose.yml new file mode 100644 index 0000000..8faf6c7 --- /dev/null +++ b/compose.yml @@ -0,0 +1,12 @@ +services: + app: + image: kou029w/nttr + build: "." + ports: ["8080:8080"] + depends_on: [redis] + environment: + REDIS_HOST: redis + REDIS_PORT: "6379" + REDIS_PASSWORD: "" + redis: + image: redis:alpine diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100755 index 0000000..a772091 --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,4 @@ +#!/bin/sh +set -e +envsubst < /nitter.example.conf > nitter.conf +exec "$@" diff --git a/fly.toml b/fly.toml new file mode 100644 index 0000000..c7954d7 --- /dev/null +++ b/fly.toml @@ -0,0 +1,26 @@ +# fly.toml file generated for nttr on 2022-07-11T18:57:16+09:00 + +app = "nttr" + +[[services]] + internal_port = 8080 + protocol = "tcp" + [services.concurrency] + hard_limit = 25 + soft_limit = 20 + type = "connections" + + [[services.ports]] + force_https = true + handlers = ["http"] + port = 80 + + [[services.ports]] + handlers = ["tls", "http"] + port = 443 + + [[services.tcp_checks]] + grace_period = "1s" + interval = "15s" + restart_limit = 0 + timeout = "2s" diff --git a/nitter.example.conf b/nitter.example.conf new file mode 100644 index 0000000..610d468 --- /dev/null +++ b/nitter.example.conf @@ -0,0 +1,48 @@ +# Created by modifying https://raw.githubusercontent.com/zedeus/nitter/master/nitter.example.conf +# @license https://raw.githubusercontent.com/zedeus/nitter/master/LICENSE + +[Server] +address = "0.0.0.0" +port = 8080 +https = false # disable to enable cookies when not using https +httpMaxConnections = 100 +staticDir = "./public" +title = "nttr.fly.dev" +hostname = "nttr.fly.dev" + +[Cache] +listMinutes = 240 # how long to cache list info (not the tweets, so keep it high) +rssMinutes = 10 # how long to cache rss queries +redisHost = "${REDIS_HOST}" # Change to "nitter-redis" if using docker-compose +redisPort = ${REDIS_PORT} +redisPassword = "${REDIS_PASSWORD}" +redisConnections = 20 # connection pool size +redisMaxConnections = 30 +# max, new connections are opened when none are available, but if the pool size +# goes above this, they're closed when released. don't worry about this unless +# you receive tons of requests per second + +[Config] +hmacKey = "${SECRET_KEY}" # random key for cryptographic signing of video urls +base64Media = false # use base64 encoding for proxied media urls +enableRSS = true # set this to false to disable RSS feeds +enableDebug = false # enable request logs and debug endpoints +proxy = "" # http/https url, SOCKS proxies are not supported +proxyAuth = "" +tokenCount = 10 +# minimum amount of usable tokens. tokens are used to authorize API requests, +# but they expire after ~1 hour, and have a limit of 187 requests. +# the limit gets reset every 15 minutes, and the pool is filled up so there's +# always at least $tokenCount usable tokens. again, only increase this if +# you receive major bursts all the time + +# Change default preferences here, see src/prefs_impl.nim for a complete list +[Preferences] +theme = "Nitter" +replaceTwitter = "nitter.net" +replaceYouTube = "piped.kavin.rocks" +replaceReddit = "teddit.net" +replaceInstagram = "" +proxyVideos = true +hlsPlayback = false +infiniteScroll = false diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..347ecf5 --- /dev/null +++ b/renovate.json @@ -0,0 +1,10 @@ +{ + "extends": [ + "config:base", + ":automergeAll", + ":automergeBranch", + ":skipStatusChecks", + "docker:enableMajor", + "docker:pinDigests" + ] +}