9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
73 |
74 |
75 |
--------------------------------------------------------------------------------
/Admin/Unencrypted/Readme.md:
--------------------------------------------------------------------------------
1 |
2 | # ⚠️Caution⚠️
3 | This HTML file is only intended to be used on the localhost or by opening it locally via a web browser. Serving this webpage publicly is not recommended as it can lead to the exposure of both the HTML and your access tokens.
4 | # Cloudflare URL Shortener Admin Panel
5 |
6 | This is a simple admin panel for Cloudflare's URL shortener service. The panel allows you to manage shortened URLs through a user-friendly interface.
7 |
8 | ## How to use
9 |
10 | To use the admin panel, follow these steps:
11 |
12 | 1. Download the HTML file to your local directory or copy the contents and paste them into your code editor. Save the file with the `.html` extension.
13 |
14 | 2. In the HTML file, update the following values to match your own setup:
15 |
16 | ```
17 | const GIST_ID = '1xxx1x1x1x1x1x1x1x1';
18 | const FILE_NAME = 'your-gist-filename.txt';
19 | const GITHUB_TOKEN = 'ghp_XxXxxXXXxXX7XCcCK';
20 | ```
21 |
22 | `GIST_ID`: The ID of your Gist file where the short URLs are stored
23 |
24 | `FILE_NAME`: The name of the file within the Gist where the short URLs are stored
25 |
26 | `GITHUB_TOKEN`: A personal access token with the necessary permissions to access your Gist file
27 |
28 | Once you have updated the values, you can open the HTML file in your web browser to access the admin panel.
29 |
30 |
31 | ## Creating a Gist Link
32 |
33 | To create a Gist link, follow these steps:
34 |
35 | 1. Create a GitHub account if you don't already have one.
36 | 2. Go to gist.github.com in your web browser.
37 | 3. Click the "New gist" button in the top-right corner of the page.
38 | 4. In the "Filename" field, enter a unique filename for your Gist.
39 | 5. In the "Add file" field, enter any text you like on the first line.
40 | 6. Click the "Create public gist" button at the bottom of the page.
41 | 7. Once the Gist is created, copy the URL of the page and save it for later.
42 | 8. In your HTML file, replace the file name, Gist ID, and URL as needed.
43 |
44 | for example The link ` https://gist.github.com/developeranaz/919999999999999999055346c` contains the unique ID `919999999999999999055346c`
45 |
46 |
47 | 
48 |
49 |
50 |
51 | ## Obtaining a GitHub Token with Only Gist Access
52 |
53 | To obtain a GitHub token with only Gist access, follow these steps:
54 |
55 | 1. Log in to your GitHub account.
56 | 2. Go to the "Settings" page for your account.
57 | 3. Click the "Developer settings" link in the sidebar.
58 | 4. Click the "Personal access tokens" link in the sidebar.
59 | 5. Click the "Generate new token" button.
60 | 6. In the "Note" field, enter a description for the token (e.g., "Gist access token").
61 | 7. Under "Select scopes", click the checkbox next to "gist".
62 | 8. Click the "Generate token" button at the bottom of the page.
63 | 9. Copy the token that is displayed on the screen and use it as needed in your code.
64 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Serverless-URL-Shortner
2 | Serverless URL shortener based on raw text link via cloudflare workers
3 | # URL Redirector
4 |
5 | This JavaScript script uses the Fetch API and the `addEventListener` function to handle a request event and redirect the user to a specific URL based on a unique ID passed in the request URL.
6 |
7 | # How to deploy to Cloudflare and create an account
8 |
9 | ## Creating a Cloudflare account
10 | 1. Go to the Cloudflare website at https://www.cloudflare.com/.
11 | 2. Click on the "Sign Up" button in the top right corner of the page.
12 | 3. Follow the prompts to create your account.
13 |
14 | ## Deploying to Cloudflare
15 | 1. Login to your Cloudflare account.
16 | 2. Go to the "Workers" section of the Cloudflare dashboard.
17 | 3. Click on the "Create a Worker" button.
18 | 4. In the "Script" section, copy the contents of your `worker.js` file.
19 | 5. Replace the 12th line of the `worker.js` file with the URL of your hosted application. For example:
20 |
21 | ```
22 | const urlList = await fetch('https://raw.githubusercontent.com/developeranaz/Serverless-URL-Shortner/main/urls.txt')
23 |
24 | ```
25 |
26 | 6. Click on the "Save and Deploy" button.
27 | 7. Test your worker by sending a request to your Cloudflare worker URL.
28 |
29 | Congratulations! Your application is now deployed to Cloudflare.
30 |
31 |
32 |
33 | ## How it works
34 |
35 | 1. The script listens for a `fetch` event using the `addEventListener` function and calls the `handleRequest` function when the event is triggered. The request object is passed to the `handleRequest` function as an argument.
36 |
37 | 2. The `handleRequest` function extracts the unique ID from the request URL by creating a new `URL` object and using the `searchParams.get()` method.
38 |
39 | 3. Next, the function fetches a raw text file containing a list of URLs and splits the text into an array of strings, one for each line.
40 |
41 | 4. The function then uses the `Array.prototype.find()` method to find the URL associated with the unique ID from the above array.
42 |
43 | 5. If the ID is not found, the function returns a new Response object with a status code of 404 and a message "Invalid ID"
44 |
45 | 6. If the ID is found, the function redirects the user to the associated URL by returning a new Response object with a status code of 301 and a `Location` header set to the URL associated with the ID.
46 |
47 | ## Example
48 |
49 | For example, if the raw text file contains the following URLs:
50 |
51 | ```
52 | abc123 https://example1.com
53 | def456 https://example2.com
54 | ghi789 https://example3.com
55 | ```
56 |
57 |
58 | and a request is made to `https://example.com?id=abc123`, the script will redirect the user to `https://example1.com`.
59 |
60 | ## TODO and Limitations
61 | I have not yet created an encrypted admin page for the URL shortener to add or remove shortened links. I will make it later. For now, please edit your raw text URL in your hosted location. I have used a raw Gist GitHub link, which can be edited later using our GitHub account. I am not aware of any security issues or disadvantages for this project, as using Gist GitHub or personal GitHub may have some rate limits. You can customize this to meet your own needs. I made this project for personal use.
62 |
--------------------------------------------------------------------------------
/urls.txt:
--------------------------------------------------------------------------------
1 | id1 https://github.com/developeranaz
2 | id2 https://github.com/developeranaz/Serverless-URL-Shortner
3 | id3 https://github.com
4 | id4 https://github.com/dev-extended
5 | id5 https://github.com/developeranaz
6 | id6 https://github.com
7 | id7 https://duckduckgo.com
8 | id8 https://startpage.com
9 | id9 https://lastentry.com
10 | id10 https://apple.com
11 | t https://apple.com
12 |
--------------------------------------------------------------------------------
/worker.js:
--------------------------------------------------------------------------------
1 | addEventListener('fetch', event => {
2 | event.respondWith(handleRequest(event.request))
3 | })
4 |
5 |
6 | async function handleRequest(request) {
7 | // Get the unique ID from the request URL
8 | // This commit is compleatly working fine with minimal fewatures
9 | const url = new URL(request.url);
10 | const id = url.searchParams.get("id");
11 | // Get the list of URLs from the raw text file
12 | const urlList = await fetch('https://raw.githubusercontent.com/developeranaz/Serverless-URL-Shortner/main/urls.txt')
13 | .then(response => response.text())
14 | .then(text => text.split('\n'))
15 | .catch(error => {
16 | return new Response(error, { status: 500 })
17 | })
18 | // Find the URL associated with the unique ID
19 | const redirectURL = urlList.find(u => u.split(" ")[0] === id);
20 | if (!redirectURL) {
21 | return new Response('Invalid ID', { status: 404 });
22 | }
23 | // Redirect to the associated URL
24 | return new Response('', {
25 | status: 301,
26 | headers: { 'Location': redirectURL.split(" ")[1] }
27 | });
28 | }
29 |
--------------------------------------------------------------------------------