Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| da457b818c | |||
| 20535f34ac | |||
| 65e355ef66 | |||
| 41a427c3a8 | |||
| 06d2e9a429 | |||
| 3205e984f1 |
201
LICENSE
Normal file
201
LICENSE
Normal file
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
57
README.md
57
README.md
@@ -33,11 +33,14 @@ The example `docker-compose.yml` uses the pre-built image from [Docker Hub](http
|
||||
|
||||
```bash
|
||||
mkdir -p data channels logs
|
||||
touch telegram_session.session
|
||||
cp config.example.json config.json
|
||||
# edit config.json with your Telegram values
|
||||
```
|
||||
|
||||
> On Linux, if the container runs as a non-root user, make sure the current user has read+write access to these folders (the example compose runs as `root`).
|
||||
> **Important:** The `telegram_session.session` file must exist (even empty) before the container starts. If the container can't find the session file, it will fail to start. Create an empty file as shown above.
|
||||
|
||||
On Linux, if the container runs as a non-root user, make sure the current user has read+write access to these folders (the example compose runs as `root`).
|
||||
|
||||
Then start the stack:
|
||||
|
||||
@@ -46,6 +49,25 @@ docker compose up -d
|
||||
docker compose logs -f telegram-backup
|
||||
```
|
||||
|
||||
> **First-time login:** After the initial `docker compose up -d`, the container will start but won't be logged in yet. You need to authenticate interactively first:
|
||||
>
|
||||
> ```bash
|
||||
> # Stop the detached container
|
||||
> docker compose down
|
||||
>
|
||||
> # Run interactively — you'll be prompted for phone number + verification code
|
||||
> # (and password if you have 2FA enabled)
|
||||
> docker compose up
|
||||
>
|
||||
> # After successful login, press Ctrl+C to stop
|
||||
> docker compose down
|
||||
>
|
||||
> # Now start detached — session is saved
|
||||
> docker compose up -d
|
||||
> ```
|
||||
>
|
||||
> The session file is written to `./telegram_session.session` on the host, so subsequent starts won't ask for verification again (unless it expires or you delete the file).
|
||||
|
||||
This is the `docker-compose.yml`:
|
||||
|
||||
```yaml
|
||||
@@ -58,7 +80,7 @@ services:
|
||||
restart: unless-stopped
|
||||
user: root
|
||||
volumes:
|
||||
- ./config.json:/app/config.json:ro
|
||||
- ./config.json:/app/config.json
|
||||
- ./telegram_session.session:/app/telegram_session.session
|
||||
- ./data:/app/data
|
||||
- ./channels:/app/channels
|
||||
@@ -81,12 +103,13 @@ Set `status_port` to `8080` in `config.json` to use the health check and expose
|
||||
|
||||
```bash
|
||||
mkdir -p data channels logs
|
||||
touch telegram_session.session
|
||||
cp config.example.json config.json
|
||||
|
||||
docker run -d \
|
||||
--name telegram-backup \
|
||||
--restart unless-stopped \
|
||||
-v $(pwd)/config.json:/app/config.json:ro \
|
||||
-v $(pwd)/config.json:/app/config.json \
|
||||
-v $(pwd)/telegram_session.session:/app/telegram_session.session \
|
||||
-v $(pwd)/data:/app/data \
|
||||
-v $(pwd)/channels:/app/channels \
|
||||
@@ -96,8 +119,34 @@ docker run -d \
|
||||
hoelee/telegram-backup-downloader:latest
|
||||
```
|
||||
|
||||
> **Important:** The `telegram_session.session` file must exist (even empty) before the container starts. Create an empty file as shown above.
|
||||
|
||||
Follow logs with `docker logs -f telegram-backup`.
|
||||
|
||||
> **First-time login:** After the initial `docker run -d`, the container will start but won't be logged in yet. You need to authenticate interactively first:
|
||||
>
|
||||
> ```bash
|
||||
> # Stop and remove the detached container
|
||||
> docker stop telegram-backup && docker rm telegram-backup
|
||||
>
|
||||
> # Run interactively — you'll be prompted for phone number + verification code
|
||||
> # (and password if you have 2FA enabled)
|
||||
> docker run -it --rm \
|
||||
> -v $(pwd)/config.json:/app/config.json \
|
||||
> -v $(pwd)/telegram_session.session:/app/telegram_session.session \
|
||||
> -v $(pwd)/data:/app/data \
|
||||
> -v $(pwd)/channels:/app/channels \
|
||||
> -v $(pwd)/logs:/app/logs \
|
||||
> -p 8080:8080 \
|
||||
> -e TZ=Asia/Kuala_Lumpur \
|
||||
> hoelee/telegram-backup-downloader:latest
|
||||
>
|
||||
> # After successful login, press Ctrl+C to exit
|
||||
> # Now run detached — session is saved to ./telegram_session.session
|
||||
> ```
|
||||
>
|
||||
> The session file is written to `./telegram_session.session` on the host, so subsequent starts won't ask for verification again (unless it expires or you delete the file).
|
||||
|
||||
### Option C: Build from source
|
||||
|
||||
```bash
|
||||
@@ -131,6 +180,8 @@ docker compose logs -f telegram-backup
|
||||
| `channel_last_message_id_overrides` | No | `{}` | One-time per-channel sync cursor overrides. With `updateonce: true`, sets the channel's SQLite `last_message_id` to the specified value, then automatically changes `updateonce` to `false` in `config.json`. Use numeric Telegram peer IDs that are included in `channels`. |
|
||||
| `manual_downloads` | No | `{}` | Message IDs to prioritize, keyed by channel ID. Useful to force-retry specific messages. Example: `{"-1001":[42,43,44]}`. Change is detected by config watcher — no restart needed. |
|
||||
|
||||
`config.json` must be mounted read-write. The program writes back to it directly — for example, when `channel_last_message_id_overrides` runs with `updateonce: true`, the downloader updates the database and then flips `updateonce` to `false` in the same file. A read-only mount (`:ro`) would break this and any other live config update.
|
||||
|
||||
`config.json` is watched every 10 seconds. Changes to channels, overrides, cursor overrides, and manual downloads are applied without restarting. Do not set `status_port`, `db_path`, worker count, or API credentials expecting a live process to rebind/recreate those resources; restart after changing them.
|
||||
|
||||
### One-Time Sync Cursor Override
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
"db_path": "/app/data/telegram_state.db",
|
||||
"channel_overrides": {
|
||||
"-1001231231231":{"turnon":false},
|
||||
"-1003213213213":{"turnon":true}
|
||||
"-1003213213213":{"turnon":false}
|
||||
},
|
||||
"channel_last_message_id_overrides": {
|
||||
"-1001231231231": {
|
||||
@@ -27,7 +27,7 @@
|
||||
"last_message_id": 123123
|
||||
},
|
||||
"-1003213213213": {
|
||||
"updateonce": true,
|
||||
"updateonce": false,
|
||||
"last_message_id": 321321
|
||||
}
|
||||
},
|
||||
|
||||
@@ -7,7 +7,8 @@ services:
|
||||
restart: unless-stopped
|
||||
user: root
|
||||
volumes:
|
||||
- ./config.json:/app/config.json:ro
|
||||
# config.json must be read-write — the program writes back to it (e.g. flips updateonce to false)
|
||||
- ./config.json:/app/config.json
|
||||
- ./telegram_session.session:/app/telegram_session.session
|
||||
- ./channels:/app/channels
|
||||
- ./logs:/app/logs
|
||||
|
||||
Reference in New Issue
Block a user