is-a-dev-docs

is-a.dev Documentation

git clone https://github.com/notamitgamer/is-a-dev-docs.git
· rebuilt hourlyOpen on GitHub
commit fa426bd8cbf06f201d2e3ab790256696be76e477
Author: William Harrison <87287585+wdhdev@users.noreply.github.com>
Date:   Sat, 31 May 2025 09:01:04 +0800

Update faq.md
Diffstat:
A.github/CODEOWNERS | 2++
A.github/workflows/main.yml | 30++++++++++++++++++++++++++++++
A.gitignore | 3+++
ALICENSE | 674+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Aretype.yml | 66++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Asrc/guides/cloudflare-pages.md | 37+++++++++++++++++++++++++++++++++++++
Asrc/guides/codeberg-pages.md | 37+++++++++++++++++++++++++++++++++++++
Asrc/guides/dbh.md | 59+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Asrc/guides/discord-verification.md | 48++++++++++++++++++++++++++++++++++++++++++++++++
Asrc/guides/github-pages.md | 80+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Asrc/guides/hashnode.md | 45+++++++++++++++++++++++++++++++++++++++++++++
Asrc/guides/improvmx.md | 38++++++++++++++++++++++++++++++++++++++
Asrc/guides/index.yml | 2++
Asrc/guides/netlify.md | 40++++++++++++++++++++++++++++++++++++++++
Asrc/guides/other.md | 17+++++++++++++++++
Asrc/guides/railway.md | 37+++++++++++++++++++++++++++++++++++++
Asrc/guides/render.md | 42++++++++++++++++++++++++++++++++++++++++++
Asrc/guides/replit.md | 39+++++++++++++++++++++++++++++++++++++++
Asrc/guides/vercel.md | 42++++++++++++++++++++++++++++++++++++++++++
Asrc/index.md | 45+++++++++++++++++++++++++++++++++++++++++++++
Asrc/media/banner.png | 0
Asrc/media/cloudflare.svg | 15+++++++++++++++
Asrc/media/codeberg.svg | 2++
Asrc/media/dbh.png | 0
Asrc/media/dbh_proxy/1.jpg | 0
Asrc/media/dbh_proxy/2.jpg | 0
Asrc/media/discord.svg | 10++++++++++
Asrc/media/discord/step_1.png | 0
Asrc/media/discord/step_2.png | 0
Asrc/media/discord/step_3.png | 0
Asrc/media/discord/step_4.png | 0
Asrc/media/discord/step_5.png | 0
Asrc/media/discord/step_6.png | 0
Asrc/media/github_pages_verification/step_1.png | 0
Asrc/media/github_pages_verification/step_2.png | 0
Asrc/media/github_pages_verification/step_3.png | 0
Asrc/media/github_pages_verification/step_4.png | 0
Asrc/media/github_pages_verification/step_5.png | 0
Asrc/media/hashnode.svg | 9+++++++++
Asrc/media/improvmx.svg | 2++
Asrc/media/logo.png | 0
Asrc/media/logo_circle.png | 0
Asrc/media/netlify.svg | 11+++++++++++
Asrc/media/railway.png | 0
Asrc/media/render.svg | 2++
Asrc/media/replit.svg | 2++
Asrc/media/resources.svg | 133+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Asrc/media/vercel.svg | 10++++++++++
Asrc/useful/domain-structure.md | 268+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Asrc/useful/faq.md | 93+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Asrc/useful/index.yml | 2++
Asrc/useful/resources.md | 36++++++++++++++++++++++++++++++++++++
52 files changed, 1978 insertions(+), 0 deletions(-)

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +* @wdhdev +/src @is-a-dev/maintainers diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml @@ -0,0 +1,30 @@ +name: Deploy + +on: + workflow_dispatch: + + push: + branches: + - main + +jobs: + publish: + name: Publish + + runs-on: ubuntu-latest + + permissions: + contents: write + + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-dotnet@v1 + with: + dotnet-version: 7.0.x + + - uses: retypeapp/action-build@latest + + - uses: retypeapp/action-github-pages@latest + with: + update-branch: true diff --git a/.gitignore b/.gitignore @@ -0,0 +1,2 @@ +.retype/ +retype.manifest +\ No newline at end of file diff --git a/LICENSE b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/retype.yml b/retype.yml @@ -0,0 +1,66 @@ +input: ./src +output: .retype +url: docs.is-a.dev +branding: + title: is-a.dev Docs + logo: /media/logo_circle.png + logoAlign: left + colors: + label: + text: "#ffffff" + background: "#9d00ff" +links: + - text: Home + link: index.md + icon: home + - text: Website + link: https://is-a.dev + icon: globe + - text: Register + link: https://github.com/is-a-dev/register + icon: mark-github + target: blank + - text: Donate + link: https://donate.is-a.dev + icon: heart + target: blank +edit: + repo: "https://github.com/is-a-dev/docs" + base: "/src" + branch: "main" + label: "Edit this page" +editor: + enabled: true +favicon: /media/logo_circle.png +generator: + recase: all +markdown: + lineBreaks: soft +meta: + title: " | is-a.dev Docs" +search: + hotkeys: + - "/" + maxResults: 20 + minChars: 2 + mode: full + noResultsFoundMsg: "No results" + placeholder: Search +start: + open: false +snippets: + lineNumbers: + - js + - none +templating: + enabled: true + liquid: false +integrations: + plausible: + domain: docs.is-a.dev + host: analytics.hrsn.net +footer: + copyright: "&copy; 2020-2025 is-a.dev - All Rights Reserved." + links: + - text: is-a-dev/docs + link: https://github.com/is-a-dev/docs diff --git a/src/guides/cloudflare-pages.md b/src/guides/cloudflare-pages.md @@ -0,0 +1,37 @@ +--- +label: Cloudflare Pages +icon: /media/cloudflare.svg +tags: guides +--- + +# Setting up Cloudflare Pages with an is-a.dev subdomain + +This guide will walk you through the process of setting up a Cloudflare Pages website and pointing your is-a.dev subdomain towards it. + +## Create a Cloudflare Pages Website + +First, you'll need to create a website on Cloudflare Pages. Follow the instructions in the [Cloudflare Pages Getting Started Guide](https://developers.cloudflare.com/pages/get-started/guide/). + +### Point your subdomain to your Cloudflare Pages site + +Next, you'll need to point your is-a.dev subdomain to your Cloudflare Pages website. Follow the instructions in the [Cloudflare Pages Custom Domains Guide](https://developers.cloudflare.com/pages/platform/custom-domains/#add-a-custom-domain). Only follow the "Add a custom domain" section, and then return to this guide for the next steps. + +### Create the Domain File + +In the `domains` directory, create a new JSON file for your subdomain (`domains/subdomain.json`) and submit a pull request. This file should contain the following: + +```json +{ + "owner": { + "username": "your-github-username", + "email": "your-email@example.com" + }, + "records": { + "CNAME": "your-sitename.pages.dev" + } +} +``` + +### Your website should be live! + +If you have followed all the steps correctly, then your website should be live after your pull request has been merged. diff --git a/src/guides/codeberg-pages.md b/src/guides/codeberg-pages.md @@ -0,0 +1,37 @@ +--- +label: Codeberg Pages +icon: /media/codeberg.svg +tags: guides +--- + +# Setting up Codeberg Pages with an is-a.dev subdomain + +This guide will walk you through the process of setting up a Codeberg Pages website and pointing your is-a.dev subdomain to it. + +## Create a Codeberg Pages Website + +First, you'll need to create a website on Codeberg Pages. Follow the instructions in the [Codeberg Pages Guide](https://docs.codeberg.org/codeberg-pages/). + +### Create the Domain File + +Create a JSON file inside domains directory (`domains/subdomain.json`) with the following content and submit a pull request: + +```json +{ + "owner": { + "username": "your-codeberg-username", + "email": "your-email@example.com" + }, + "records": { + "CNAME": "pages.your-codeberg-username.codeberg.page" + } +} +``` + +### Add `.domains` file + +Once your PR is merged, Make a `.domains` file to point your website to your new `.is-a.dev` domain and add your subdomain (`your-subdomain.is-a.dev`) to it. + +### Done! + +If you've followed everything correctly your website should be live :) diff --git a/src/guides/dbh.md b/src/guides/dbh.md @@ -0,0 +1,59 @@ +--- +label: DanBot Hosting +tags: guides +icon: /media/dbh.png +--- + +# Setting up DanBot Hosting with an is-a.dev subdomain + +This guide will walk you through the process of setting up a DanBot Hosting website and pointing your is-a.dev subdomain to it. + +## Getting Proxy IP + +Execute the following command in [DanBot Hosting Discord server](https://discord.gg/dbh) in the `#commands` channel. + +``` +dbh!server proxy +``` + +You will get a reply like this: + +![](../media/dbh_proxy/1.jpg) + +If you are on a free plan, choose any US proxy or you can use the Donator Proxy If you are a Donator, note the IP address of the proxy you chose. + +### Creating the domain file + +Create a JSON file inside `domains` directory (`domains/subdomain.json`) with the following content and submit a pull request: + +```json +{ + "owner": { + "username": "github-username", + "email": "me@example.com" + }, + "records": { + "A": ["proxy-ip-here"] + } +} +``` + +**Note:** In the owner section, you can add any social media handle, such as Discord. If you add another social media account, you may omit the email field. However, the GitHub username is mandatory. Don't forget to provide a preview of your website in your pull request. + +## Configuring + +After your pull request is merged, get your server ID by running this command: + +``` +dbh!server list +``` + +You will get a reply like this: + +![](../media/dbh_proxy/2.jpg) + +Note down the server ID, then execute following command: + +``` +dbh!server proxy your-subdomain.is-a.dev yourserverid +``` diff --git a/src/guides/discord-verification.md b/src/guides/discord-verification.md @@ -0,0 +1,48 @@ +--- +icon: /media/discord.svg +label: Discord Domain Connection +tags: guides +--- + +# Setting up Discord domain connection with your is-a.dev subdomain + +## Get your verification string + +1. Open your Discord app and press `Settings`. + ![](../media/discord/step_1.png) + +2. Open the `Connections` section. + ![](../media/discord/step_2.png) + +3. Press the `View more` button. + ![](../media/discord/step_3.png) + +4. Click on the domain button (the globe icon). + ![](../media/discord/step_4.png) + +5. In the field that appears type your is-a.dev domain name (e.g. `example.is-a.dev`). + ![](../media/discord/step_5.png) + +6. Copy the verification string. + ![](../media/discord/step_6.png) + +### Edit your domain file + +!!! +You must already own an is-a.dev domain to do this. +!!! + +Edit your domain file (`domains/your-domain.json`) and **add this snippet after the `records` key**: + +```json +"services": { + "discord": "your-discord-verification-string" +} +``` + +Please remember to add a comma after the `records` key's closing brace! + +## Configuration + +After your pull request has been merged, repeat steps 1–5 and press the `Verify` button. +If it shows any error such as `Unable to verify your domain`, try waiting a few minutes (sometimes up to 24 hours) as the DNS might not have propagated yet. diff --git a/src/guides/github-pages.md b/src/guides/github-pages.md @@ -0,0 +1,80 @@ +--- +label: GitHub Pages +icon: mark-github +tags: guides +--- + +## Setting up GitHub pages with an is-a.dev subdomain + +This guide will walk you through the process of setting up a GitHub Pages site and pointing your is-a.dev subdomain to it. + +### Creating a GitHub Pages repository + +First, you'll need to create a site on GitHub Pages. Follow the instructions in the [GitHub Pages Getting Started Guide](https://docs.github.com/en/pages/getting-started-with-github-pages). + +### Creating the domain file + +Create a JSON file inside `domains` directory (`domains/subdomain.json`) with the following content and submit a pull request: + +```json +{ + "owner": { + "username": "github-username", + "email": "me@example.com" + }, + "records": { + "CNAME": "github-username.github.io" + } +} +``` + +### Configuring + +- After the pull request is merged, you may see a **404** error on `subdomain.is-a.dev` or the wrong site. To fix this issue, go to your GitHub pages repository and navigate to: **Settings > GitHub pages > Custom Domain** and add `subdomain.is-a.dev` in the given field. *Only do this **after** your pull request is merged.* +- Check the **Enforce HTTPS** checkbox below the custom domain input. +- Wait some time and your site should be live! + +## Verifying your is-a.dev Subdomain with GitHub Pages + +### Get your verification string + +1. Navigate to GitHub, press your profile icon at the top right, and press `Settings`. + +![](../media/github_pages_verification/step_1.png) + +2. Press `Pages`. + +![](../media/github_pages_verification/step_2.png) + +3. Press `Add a domain`. + +![](../media/github_pages_verification/step_3.png) + +4. In the field that appears, type your is-a.dev subdomain name (e.g. `myname.is-a.dev`) and press `Add domain`. + +![](../media/github_pages_verification/step_4.png) + +5. Copy the hostname and the verification string. + +![](../media/github_pages_verification/step_5.png) + +### Create the domain file + +Create a JSON file inside the `domains/` directory called `domains/hostname.subdomain.json` using the hostname you copied in step 5 and subdomain (`subdomain.is-a.dev`) with the following content and submit a pull request: + +```json +{ + "owner": { + "username": "github-username", + "email": "me@example.com" + }, + "records": { + "TXT": "github-verification-string" + } +} +``` + +### Configuration + +After your pull request has been merged, repeat the steps to get the verification string and press the `Verify` button. +If it shows an error such as `Unable to verify your domain`, try waiting a few minutes (sometimes up to 24 hours) as the DNS records may not have propagated yet. diff --git a/src/guides/hashnode.md b/src/guides/hashnode.md @@ -0,0 +1,45 @@ +--- +icon: /media/hashnode.svg +label: Hashnode +tags: guides +--- + +# Hashnode Blog + +When you create your Hashnode blog, Hashnode provides a free `hashnode.dev` subdomain for you. However, you can alternatively set up your own `is-a.dev` subdomain. + +In this guide, you will learn how to accomplish this. + +--- + +1. Log in to your Hashnode account. + +1. Click on your **avatar** at the bottom-left corner of the page on **desktop** or top-right corner on **mobile**. + ![Hashnode's Feed](https://cdn.hashnode.com/res/hashnode/image/upload/v1614932849541/cBNDGKXMj.png?auto=compress) + +1. Click on the **Blog Dashboard** option from the popup modal to access your blog's dashboard. + ![Hashnode's Feed](https://cdn.hashnode.com/res/hashnode/image/upload/v1614937218081/InvxVHXDy.png?auto=compress) + +1. Navigate to the **Domain** tab and enter your domain without the **www** or **https://** prefix in the text field provided. Then click on the **Update** button to proceed. + ![Hashnode's Blog Domain Tab](https://cdn.hashnode.com/res/hashnode/image/upload/v1614937377176/0cwddAywO.png?auto=compress) + +1. Go to your fork of the `is-a-dev/register` repository, edit your subdomain's JSON file, make sure you remove any old records, then add this to the `record` key and create a PR: + +```json +"CNAME": "hashnode.network" +``` + +## Configuration + +Once done, your Hashnode blog should be setup to use your subdomain. These changes could take from 1 hour to around 48 hours, so please be patient. It'll most likely be ready within a hour. + +Once the DNS has propagated, you can start enjoying your Hashnode blog with your sweet `.is-a.dev` subdomain! + +## Need More Help? + +If you encounter any issues or need further assistance, consider the following resources: + +- [Hashnode Domain Mapping Guide](https://support.hashnode.com/docs/mapping-domain/): This support article provides detailed instructions on mapping your domain in Hashnode. +- [Hashnode Support Center](https://support.hashnode.com/): For more general help related to Hashnode, visit their Support Center. + +Please note that is-a.dev is not affiliated with Hashnode. If you're experiencing issues with your Hashnode blog, please seek help through Hashnode's support channels. We are unable to assist with Hashnode-specific issues. diff --git a/src/guides/improvmx.md b/src/guides/improvmx.md @@ -0,0 +1,38 @@ +--- +label: ImprovMX +icon: /media/improvmx.svg +tags: guides +--- + +# Setting up ImprovMX with an is-a.dev subdomain + +This guide will walk you through the process of setting up ImprovMX with your is-a.dev subdomain. + +## Requirements + +1. You must have an ImprovMX account. If you don't have an ImprovMX account, please visit [their website](https://improvmx.com) and create an account. +2. You should have already forked the [is-a.dev repository](https://github.com/is-a-dev/register). If you haven't forked the repository, please make one by using [this link](https://github.com/is-a-dev/register/fork). + +## Creating the file + +Visit your fork and navigate into the `domains` directory and create a file. The file should be named in this manner: `subdomain.json`. (Replace `subdomain` with the subdomain name that you want.) + +After you've made the file, it should look like this: +```json +{ + "owner": { + "username": "github-username", + "email": "me@example.com" + }, + "records": { + "MX": ["mx1.improvmx.com", "mx2.improvmx.com"], + "TXT": ["v=spf1 include:spf.improvmx.com ~all"] + } +} +``` + +**After you've made the file, make a pull request to the [is-a.dev repository](https://github.com/is-a-dev/register).** + +## Configuring + +After your pull request has been merged, the MX records should be recognized automatically and start working. If you haven't configured it beforehand, please go to the [ImprovMX dashboard](https://app.improvmx.com/) and add the subdomain there. diff --git a/src/guides/index.yml b/src/guides/index.yml @@ -0,0 +1 @@ +icon: book +\ No newline at end of file diff --git a/src/guides/netlify.md b/src/guides/netlify.md @@ -0,0 +1,40 @@ +--- +icon: /media/netlify.svg +label: Netlify +tags: guides +--- + +# Setting up Netlify with an is-a.dev Subdomain + +This guide will walk you through the process of setting up a Netlify deployment and pointing your is-a.dev subdomain towards it. + +## Creating a Netlify Website + +First, create a website on Netlify. Follow the instructions in the [Netlify Docs](https://docs.netlify.com/). + +### Creating the Domain File + +Create a JSON file inside the `domains` directory (`domains/subdomain.json`) with the following content and submit a pull request: + +```json +{ + "owner": { + "username": "github-username", + "email": "me@example.com" + }, + "records": { + "A": ["75.2.60.5"] + } +} +``` + +**Note:** In the owner section, you can add any social media handle, such as Discord. If you add another social media account, you can omit the email field. However, the GitHub username is mandatory. Don't forget to provide a preview of your website in your pull request. + +## Configuring Netlify +- After your pull request is merged, you may need to configure your Netlify website to use the new subdomain. Visit your Netlify website's dashboard. +- Navigate to **Site Settings > Domain Management > Custom Domains** and add `subdomain.is-a.dev` in the given field. +- Netlify will provide a verification step, usually requiring you to add a DNS record. You should be able to skip this step if your subdomain is already pointing to Netlify's IP address (`75.2.60.5`). + +### Final Steps +- Wait for the DNS changes to propagate. This can take from a few minutes to a couple of hours. +- Your Netlify website should now be accessible at `your-subdomain.is-a.dev`. diff --git a/src/guides/other.md b/src/guides/other.md @@ -0,0 +1,17 @@ +--- +label: Other services +icon: server +tags: guides +--- + +# Setting up other services with is-a.dev + +## Setting up records + +Read the [domain file structure](../useful/domain-structure) and set up the records accordingly. + +## Configuring your server + +After the pull request is merged, configure your server (apache, nginx, etc.) to work with `subdomain.is-a.dev`. If you are unsure how to configure your server, you can [create an issue](https://github.com/is-a-dev/register/issues/new/choose) for support. + +You should also include `subdomain.is-a.dev` in your ssl certificate to get rid of certificate errors. diff --git a/src/guides/railway.md b/src/guides/railway.md @@ -0,0 +1,37 @@ +--- +icon: /media/railway.png +label: Railway +tags: guides +--- + +# Setting up is-a.dev with Railway + +## Getting the CNAME Record + +1. Navigate to the [dashboard](https://railway.app/dashboard) +2. Navigate to the project. +3. Navigate to the service. +4. Switch to the **Settings** tab. +5. Click on **+ Custom Domain** button. +6. Enter the `is-a.dev` subdomain you want to use. +7. Copy the **Value** field. +8. For the domain, make the json like this: +```json +{ + "owner": { + "username": "your-github-username", + "email": "your-email@example.com" + }, + "records": { + "CNAME": "the-value-railway-gave-you" + } +} +``` +9. After you have made the file, you should make a pull request. +!!! +**Adding the website preview is mandatory**, since the CNAME value Railway gives you doesn't actually show you the website you are running. +!!! + + +- **If the PR has been merged, the DNS records will be updated in a few minutes.** +- **If the PR has been merged but the DNS records haven't updated and you have waited 48 hours, [open a GitHub issue](https://github.com/is-a-dev/register/issues/new/choose) or a help thread in the is-a.dev [Discord server](https://discord.gg/is-a-dev-830872854677422150).** diff --git a/src/guides/render.md b/src/guides/render.md @@ -0,0 +1,42 @@ +--- +icon: /media/render.svg +label: Render +tags: guides +--- + +# Setting up Render with an is-a.dev Subdomain + +This guide will walk you through the process of setting up a Render deployment and pointing your is-a.dev subdomain towards it. + +## Creating a Render Service + +First, create a service on Render. Follow the instructions in the [Render Documentation](https://docs.render.com/). + +### Creating the Domain File + +Create a JSON file inside the `domains` directory (`domains/subdomain.json`) with the following content and submit a pull request: + +```json +{ + "owner": { + "username": "your-github-username", + "email": "me@example.com" + }, + "records": { + "A": ["216.24.57.1"] + } +} +``` + +**Note:** In the owner section, you can add any social media handle, such as Discord. If you add another social media account, you can omit the email field. However, the GitHub username is mandatory. Don't forget to provide a preview of your website in your pull request. + +## Configuring Render + +- After your pull request is merged, you may need to configure your Render service to use the new subdomain. Go to your Render service's dashboard. +- Navigate to **Settings > Custom Domains** and add `subdomain.is-a.dev` in the given field. +- Render will provide a verification step, usually requiring you to add a DNS record. This step should be skipped if your subdomain is already pointing to Render's IP address (`216.24.57.1`). + +### Final Steps + +- Wait for the DNS changes to propagate. This can take from a few minutes to a couple of hours. +- Your Render service should now be accessible at `subdomain.is-a.dev`. diff --git a/src/guides/replit.md b/src/guides/replit.md @@ -0,0 +1,39 @@ +--- +icon: /media/replit.svg +label: Replit +tags: guides +--- + +# Setting up Replit with an is-a.dev subdomain + +## Creating a project + +Follow the instructions in the [Replit Workspace Guide](https://docs.replit.com/programming-ide/introduction-to-the-workspace#how-to-create-a-repl) on how to create a project. + +### Connect your repl to your is-a.dev subdomain + +Follow the instructions in the [Replit Custom Domains Guide](https://docs.replit.com/hosting/custom-domains#connecting-your-domain-to-your-repl). + +Only follow the "Connecting your domain to your repl" section, then return to this guide for the next steps. + +### Creating the domain file + +Create a JSON file inside `domains` directory (`domains/subdomain.json`) with the following content: + +**Note:** Do not add any TXT records, even if Replit instructs you to do so. + +```json +{ + "owner": { + "username": "your-github-username", + "email": "me@example.com" + }, + "records": { + "CNAME": "siteid.id.repl.co" + } +} +``` + +## Finish + +Once your pull request has been merged you should be able to visit your new is-a.dev subdomain connected to your Replit site! diff --git a/src/guides/vercel.md b/src/guides/vercel.md @@ -0,0 +1,42 @@ +--- +icon: /media/vercel.svg +label: Vercel +tags: guides +--- + +# Setting up Vercel with an is-a.dev subdomain + +This guide will walk you through the process of setting up a Vercel site and pointing your is-a.dev subdomain towards it. + +## Ensure you have a Vercel site + +If you haven't made a Vercel site, make sure to make one. Follow the instructions in [Vercel's Docs](https://vercel.com/docs/getting-started-with-vercel). + +### Creating the domain + +1. Navigate to your Vercel dashboard. Then, navigate to the "Domains" tab of your project's settings. Click "Add Domain" and enter the is-a.dev subdomain you want (e.g. `example.is-a.dev`). +2. Once you're past the "Configure Environment and Redirects" tab—if unsure, just click "Save"—then click "Continue manually". Copy the TXT verification value that you'll get; you'll need this in step 4. +3. Fork our [repository](https://github.com/is-a-dev/register) and create a file **in the `/domains` folder** named `your-domain.json`. Replace `your-domain` with the name of the subdomain you chose earlier in the Vercel dashboard. +4. In this file, paste the following JSON and ***make sure to replace all the values properly***, except for the CNAME, which you should leave untouched. + +```json +{ + "owner": { + "username": "your-github-username", + "email": "your-email-address@example.com" + }, + "records": { + "CNAME": "cname.vercel-dns.com" + }, + "services": { + "vercel": "insert-TXT-string-you-got-from-vercel-here" + } +} +``` + + +### Make a pull request + +Once you have created your file, make a pull request to the [main repository](https://github.com/is-a-dev/register). Then you'll need to be patient until it gets merged. If you want a chance to get your PR merged faster, join our [Discord server](https://discord.gg/is-a-dev-830872854677422150) and send your pull request link ***once*** in `#pull-requests`. + +Once the pull request has been merged your site should be working; if it is still redirecting to the is-a.dev site, try clearing your cache. diff --git a/src/index.md b/src/index.md @@ -0,0 +1,45 @@ +--- +label: Welcome +icon: home +--- +<!-- Do not provide meta name as it messes with SEO --> +![](media/banner.png) + +# is-a.dev Documentation +Here you'll find detailed guides, the JSON file structure, and more. If you'd like to contribute to our documentation, visit [our documentation repository](https://github.com/is-a-dev/docs) on GitHub. + +## How to Register +You can read about the domains' JSON file structure [here](useful/domain-structure). + +## Guides +- [Cloudflare Pages](guides/cloudflare-pages) +- [DanBot Hosting](guides/dbh) +- [Discord Domain Verification](guides/discord-verification) +- [GitHub Pages](guides/github-pages) +- [Hashnode Blogs](guides/hashnode) +- [ImprovMX](guides/improvmx) +- [Netlify](guides/netlify) +- [Other Services](guides/other) +- [Railway](guides/railway) +- [Render](guides/render) +- [Replit](guides/replit) +- [Vercel](guides/vercel) + +## Useful + - [Domain Structure](useful/domain-structure) + - [FAQ](useful/faq) + - [Resources](useful/resources) + +## Official Subdomains +These are the official subdomains run by the is-a.dev staff team. + +- [`is-a.dev`](https://is-a.dev) (the root domain, used for the main page, documentation, and emails.) +- [`all.is-a.dev`](https://all.is-a.dev) (visualization of [raw.is-a.dev](raw.is-a.dev), run by [@JustDeveloper1](https://github.com/JustDeveloper1).) +- [`data.is-a.dev`](https://data.is-a.dev) (data visualization website, run by [@wdhdev](https://github.com/wdhdev).) +- `docs.is-a.dev` (this website.) +- [`factory.is-a.dev`](https://factory.is-a.dev) (Subdomain JSON file generator/factory.) +- [`raw.is-a.dev`](https://raw.is-a.dev) (raw JSON API of all is-a.dev subdomains, run by [@wdhdev](https://github.com/wdhdev).) + +**Do *NOT* trust any websites claiming to be us that are not listed here. If you find any, please report them to [security@is-a.dev](mailto:security@is-a.dev).** + +*We do not unsolicitedly send emails to users, do not trust any unsolicited emails claiming they are us. Report any unsolicited emails to [security@is-a.dev](mailto:security@is-a.dev).* diff --git a/src/media/banner.png b/src/media/banner.png Binary files differ. diff --git a/src/media/cloudflare.svg b/src/media/cloudflare.svg @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools --> +<svg width="800px" height="800px" viewBox="0 -70 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid"> + <g> + <g transform="translate(0.000000, -1.000000)"> + <path d="M202.3569,50.394 L197.0459,48.27 C172.0849,104.434 72.7859,70.289 66.8109,86.997 C65.8149,98.283 121.0379,89.143 160.5169,91.056 C172.5559,91.639 178.5929,100.727 173.4809,115.54 L183.5499,115.571 C195.1649,79.362 232.2329,97.841 233.7819,85.891 C231.2369,78.034 191.1809,85.891 202.3569,50.394 Z" fill="#FFFFFF"> +</path> + <path d="M176.332,109.3483 C177.925,104.0373 177.394,98.7263 174.739,95.5393 C172.083,92.3523 168.365,90.2283 163.585,89.6973 L71.17,88.6343 C70.639,88.6343 70.108,88.1033 69.577,88.1033 C69.046,87.5723 69.046,87.0413 69.577,86.5103 C70.108,85.4483 70.639,84.9163 71.701,84.9163 L164.647,83.8543 C175.801,83.3233 187.486,74.2943 191.734,63.6723 L197.046,49.8633 C197.046,49.3313 197.577,48.8003 197.046,48.2693 C191.203,21.1823 166.772,0.9993 138.091,0.9993 C111.535,0.9993 88.697,17.9953 80.73,41.8963 C75.419,38.1783 69.046,36.0533 61.61,36.5853 C48.863,37.6473 38.772,48.2693 37.178,61.0163 C36.647,64.2033 37.178,67.3903 37.71,70.5763 C16.996,71.1073 0,88.1033 0,109.3483 C0,111.4723 0,113.0663 0.531,115.1903 C0.531,116.2533 1.593,116.7843 2.125,116.7843 L172.614,116.7843 C173.676,116.7843 174.739,116.2533 174.739,115.1903 L176.332,109.3483 Z" fill="#F4811F"> +</path> + <path d="M205.5436,49.8628 L202.8876,49.8628 C202.3566,49.8628 201.8256,50.3938 201.2946,50.9248 L197.5766,63.6718 C195.9836,68.9828 196.5146,74.2948 199.1706,77.4808 C201.8256,80.6678 205.5436,82.7918 210.3236,83.3238 L229.9756,84.3858 C230.5066,84.3858 231.0376,84.9168 231.5686,84.9168 C232.0996,85.4478 232.0996,85.9788 231.5686,86.5098 C231.0376,87.5728 230.5066,88.1038 229.4436,88.1038 L209.2616,89.1658 C198.1076,89.6968 186.4236,98.7258 182.1746,109.3478 L181.1116,114.1288 C180.5806,114.6598 181.1116,115.7218 182.1746,115.7218 L252.2826,115.7218 C253.3446,115.7218 253.8756,115.1908 253.8756,114.1288 C254.9376,109.8798 255.9996,105.0998 255.9996,100.3188 C255.9996,72.7008 233.1616,49.8628 205.5436,49.8628" fill="#FAAD3F"> +</path> + </g> + </g> +</svg> +\ No newline at end of file diff --git a/src/media/codeberg.svg b/src/media/codeberg.svg @@ -0,0 +1 @@ +<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Codeberg</title><path d="M11.955.49A12 12 0 0 0 0 12.49a12 12 0 0 0 1.832 6.373L11.838 5.928a.187.14 0 0 1 .324 0l10.006 12.935A12 12 0 0 0 24 12.49a12 12 0 0 0-12-12 12 12 0 0 0-.045 0zm.375 6.467l4.416 16.553a12 12 0 0 0 5.137-4.213z" fill="white"/></svg> +\ No newline at end of file diff --git a/src/media/dbh.png b/src/media/dbh.png Binary files differ. diff --git a/src/media/dbh_proxy/1.jpg b/src/media/dbh_proxy/1.jpg Binary files differ. diff --git a/src/media/dbh_proxy/2.jpg b/src/media/dbh_proxy/2.jpg Binary files differ. diff --git a/src/media/discord.svg b/src/media/discord.svg @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools --> +<svg width="800px" height="800px" viewBox="0 -28.5 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid"> + <g> + <path d="M216.856339,16.5966031 C200.285002,8.84328665 182.566144,3.2084988 164.041564,0 C161.766523,4.11318106 159.108624,9.64549908 157.276099,14.0464379 C137.583995,11.0849896 118.072967,11.0849896 98.7430163,14.0464379 C96.9108417,9.64549908 94.1925838,4.11318106 91.8971895,0 C73.3526068,3.2084988 55.6133949,8.86399117 39.0420583,16.6376612 C5.61752293,67.146514 -3.4433191,116.400813 1.08711069,164.955721 C23.2560196,181.510915 44.7403634,191.567697 65.8621325,198.148576 C71.0772151,190.971126 75.7283628,183.341335 79.7352139,175.300261 C72.104019,172.400575 64.7949724,168.822202 57.8887866,164.667963 C59.7209612,163.310589 61.5131304,161.891452 63.2445898,160.431257 C105.36741,180.133187 151.134928,180.133187 192.754523,160.431257 C194.506336,161.891452 196.298154,163.310589 198.110326,164.667963 C191.183787,168.842556 183.854737,172.420929 176.223542,175.320965 C180.230393,183.341335 184.861538,190.991831 190.096624,198.16893 C211.238746,191.588051 232.743023,181.531619 254.911949,164.955721 C260.227747,108.668201 245.831087,59.8662432 216.856339,16.5966031 Z M85.4738752,135.09489 C72.8290281,135.09489 62.4592217,123.290155 62.4592217,108.914901 C62.4592217,94.5396472 72.607595,82.7145587 85.4738752,82.7145587 C98.3405064,82.7145587 108.709962,94.5189427 108.488529,108.914901 C108.508531,123.290155 98.3405064,135.09489 85.4738752,135.09489 Z M170.525237,135.09489 C157.88039,135.09489 147.510584,123.290155 147.510584,108.914901 C147.510584,94.5396472 157.658606,82.7145587 170.525237,82.7145587 C183.391518,82.7145587 193.761324,94.5189427 193.539891,108.914901 C193.539891,123.290155 183.391518,135.09489 170.525237,135.09489 Z" fill="#5865F2" fill-rule="nonzero"> + +</path> + </g> +</svg> +\ No newline at end of file diff --git a/src/media/discord/step_1.png b/src/media/discord/step_1.png Binary files differ. diff --git a/src/media/discord/step_2.png b/src/media/discord/step_2.png Binary files differ. diff --git a/src/media/discord/step_3.png b/src/media/discord/step_3.png Binary files differ. diff --git a/src/media/discord/step_4.png b/src/media/discord/step_4.png Binary files differ. diff --git a/src/media/discord/step_5.png b/src/media/discord/step_5.png Binary files differ. diff --git a/src/media/discord/step_6.png b/src/media/discord/step_6.png Binary files differ. diff --git a/src/media/github_pages_verification/step_1.png b/src/media/github_pages_verification/step_1.png Binary files differ. diff --git a/src/media/github_pages_verification/step_2.png b/src/media/github_pages_verification/step_2.png Binary files differ. diff --git a/src/media/github_pages_verification/step_3.png b/src/media/github_pages_verification/step_3.png Binary files differ. diff --git a/src/media/github_pages_verification/step_4.png b/src/media/github_pages_verification/step_4.png Binary files differ. diff --git a/src/media/github_pages_verification/step_5.png b/src/media/github_pages_verification/step_5.png Binary files differ. diff --git a/src/media/hashnode.svg b/src/media/hashnode.svg @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools --> +<svg width="800px" height="800px" viewBox="0 0 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> + <g fill-rule="evenodd"> + <path d="M17.5913461,85.5328619 C-5.86378203,108.98799 -5.86378203,147.01185 17.5913461,170.464766 L85.5337714,238.409404 C108.9889,261.862319 147.01276,261.862319 170.465675,238.409404 L238.410313,170.464766 C261.863229,147.009638 261.863229,108.985777 238.410313,85.5328619 L170.465675,17.5904365 C147.010547,-5.86247884 108.986687,-5.86247884 85.5337714,17.5904365 L17.5913461,85.5328619 Z M157.724673,157.725976 C174.143262,141.307386 174.143262,114.690241 157.724673,98.2738645 C141.308296,81.8552748 114.691151,81.8552748 98.274774,98.2738645 C81.8561843,114.692454 81.8561843,141.307386 98.274774,157.725976 C114.693364,174.142353 141.308296,174.142353 157.726886,157.725976 L157.724673,157.725976 Z" fill="#2962FF"> +</path> + </g> +</svg> +\ No newline at end of file diff --git a/src/media/improvmx.svg b/src/media/improvmx.svg @@ -0,0 +1 @@ +<svg width="28" height="29" xmlns="http://www.w3.org/2000/svg"><g fill="#2FBEFF" fill-rule="evenodd"><path d="M17.6 25.07a5.43 5.43 0 0 1-7.73 0 6.9 6.9 0 0 0-3.93-1.94v1.51c1.04.2 2.05.7 2.86 1.5a6.93 6.93 0 0 0 4.93 2.05c1.86 0 3.61-.73 4.93-2.05a5.42 5.42 0 0 1 2.7-1.46v-1.53c-1.38.23-2.7.86-3.77 1.92"></path><path d="M17.6 21.25a5.43 5.43 0 0 1-7.73 0 6.99 6.99 0 0 0-9.87 0l1.07 1.07a5.47 5.47 0 0 1 7.73 0 6.93 6.93 0 0 0 4.93 2.05c1.86 0 3.61-.73 4.93-2.05a5.47 5.47 0 0 1 7.73 0l1.07-1.07a6.99 6.99 0 0 0-9.87 0"></path><path d="M13.78 8.46l-5.54 3-.02-5.88h1.95l7.2-.03h1.95l.01 5.87-5.55-2.96zm2.02-6.9L15.81 4l-4.09.01V1.57h4.08zm5.1 10.7l-.03-8.27h-3.5L17.36 0l-7.2.02v4h-3.5l.02 8.27-3.25 1.76 1.08 3.9a6.8 6.8 0 0 1 1.63.08l-.88-3.2L13 10.65l.02 10.04h1.56l-.03-10.04 7.77 4.14-.84 3.12a6.8 6.8 0 0 1 1.58.1L24.16 14l-3.27-1.74z"></path></g></svg> +\ No newline at end of file diff --git a/src/media/logo.png b/src/media/logo.png Binary files differ. diff --git a/src/media/logo_circle.png b/src/media/logo_circle.png Binary files differ. diff --git a/src/media/netlify.svg b/src/media/netlify.svg @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="utf-8"?><!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools --> +<svg width="800px" height="800px" viewBox="0 0 40 40" xmlns="http://www.w3.org/2000/svg"> + <defs> + <radialGradient id="a" cy="0%" r="100.11%" fx="50%" fy="0%" gradientTransform="matrix(0 .9989 -1.152 0 .5 -.5)"> + <stop offset="0%" stop-color="#20C6B7"/> + <stop offset="100%" stop-color="#4D9ABF"/> + </radialGradient> + </defs> + <path fill="url(#a)" d="M28.589 14.135l-.014-.006c-.008-.003-.016-.006-.023-.013a.11.11 0 0 1-.028-.093l.773-4.726 3.625 3.626-3.77 1.604a.083.083 0 0 1-.033.006h-.015c-.005-.003-.01-.007-.02-.017a1.716 1.716 0 0 0-.495-.381zm5.258-.288l3.876 3.876c.805.806 1.208 1.208 1.355 1.674.022.069.04.138.054.209l-9.263-3.923a.728.728 0 0 0-.015-.006c-.037-.015-.08-.032-.08-.07 0-.038.044-.056.081-.071l.012-.005 3.98-1.684zm5.127 7.003c-.2.376-.59.766-1.25 1.427l-4.37 4.369-5.652-1.177-.03-.006c-.05-.008-.103-.017-.103-.062a1.706 1.706 0 0 0-.655-1.193c-.023-.023-.017-.059-.01-.092 0-.005 0-.01.002-.014l1.063-6.526.004-.022c.006-.05.015-.108.06-.108a1.73 1.73 0 0 0 1.16-.665c.009-.01.015-.021.027-.027.032-.015.07 0 .103.014l9.65 4.082zm-6.625 6.801l-7.186 7.186 1.23-7.56.002-.01c.001-.01.003-.02.006-.029.01-.024.036-.034.061-.044l.012-.005a1.85 1.85 0 0 0 .695-.517c.024-.028.053-.055.09-.06a.09.09 0 0 1 .029 0l5.06 1.04zm-8.707 8.707l-.81.81-8.955-12.942a.424.424 0 0 0-.01-.014c-.014-.019-.029-.038-.026-.06.001-.016.011-.03.022-.042l.01-.013c.027-.04.05-.08.075-.123l.02-.035.003-.003c.014-.024.027-.047.051-.06.021-.01.05-.006.073-.001l9.921 2.046a.164.164 0 0 1 .076.033c.013.013.016.027.019.043a1.757 1.757 0 0 0 1.028 1.175c.028.014.016.045.003.078a.238.238 0 0 0-.015.045c-.125.76-1.197 7.298-1.485 9.063zm-1.692 1.691c-.597.591-.949.904-1.347 1.03a2 2 0 0 1-1.206 0c-.466-.148-.869-.55-1.674-1.356L8.73 28.73l2.349-3.643c.011-.018.022-.034.04-.047.025-.018.061-.01.091 0a2.434 2.434 0 0 0 1.638-.083c.027-.01.054-.017.075.002a.19.19 0 0 1 .028.032L21.95 38.05zM7.863 27.863L5.8 25.8l4.074-1.738a.084.084 0 0 1 .033-.007c.034 0 .054.034.072.065a2.91 2.91 0 0 0 .13.184l.013.016c.012.017.004.034-.008.05l-2.25 3.493zm-2.976-2.976l-2.61-2.61c-.444-.444-.766-.766-.99-1.043l7.936 1.646a.84.84 0 0 0 .03.005c.049.008.103.017.103.063 0 .05-.059.073-.109.092l-.023.01-4.337 1.837zM.831 19.892a2 2 0 0 1 .09-.495c.148-.466.55-.868 1.356-1.674l3.34-3.34a2175.525 2175.525 0 0 0 4.626 6.687c.027.036.057.076.026.106-.146.161-.292.337-.395.528a.16.16 0 0 1-.05.062c-.013.008-.027.005-.042.002H9.78L.831 19.891zm5.68-6.403l4.491-4.491c.422.185 1.958.834 3.332 1.414 1.04.44 1.988.84 2.286.97.03.012.057.024.07.054.008.018.004.041 0 .06a2.003 2.003 0 0 0 .523 1.828c.03.03 0 .073-.026.11l-.014.021-4.56 7.063c-.012.02-.023.037-.043.05-.024.015-.058.008-.086.001a2.274 2.274 0 0 0-.543-.074c-.164 0-.342.03-.522.063h-.001c-.02.003-.038.007-.054-.005a.21.21 0 0 1-.045-.051l-4.808-7.013zm5.398-5.398l5.814-5.814c.805-.805 1.208-1.208 1.674-1.355a2 2 0 0 1 1.206 0c.466.147.869.55 1.674 1.355l1.26 1.26-4.135 6.404a.155.155 0 0 1-.041.048c-.025.017-.06.01-.09 0a2.097 2.097 0 0 0-1.92.37c-.027.028-.067.012-.101-.003-.54-.235-4.74-2.01-5.341-2.265zm12.506-3.676l3.818 3.818-.92 5.698v.015a.135.135 0 0 1-.008.038c-.01.02-.03.024-.05.03a1.83 1.83 0 0 0-.548.273.154.154 0 0 0-.02.017c-.011.012-.022.023-.04.025a.114.114 0 0 1-.043-.007l-5.818-2.472-.011-.005c-.037-.015-.081-.033-.081-.071a2.198 2.198 0 0 0-.31-.915c-.028-.046-.059-.094-.035-.141l4.066-6.303zm-3.932 8.606l5.454 2.31c.03.014.063.027.076.058a.106.106 0 0 1 0 .057c-.016.08-.03.171-.03.263v.153c0 .038-.039.054-.075.069l-.011.004c-.864.369-12.13 5.173-12.147 5.173-.017 0-.035 0-.052-.017-.03-.03 0-.072.027-.11a.76.76 0 0 0 .014-.02l4.482-6.94.008-.012c.026-.042.056-.089.104-.089l.045.007c.102.014.192.027.283.027.68 0 1.31-.331 1.69-.897a.16.16 0 0 1 .034-.04c.027-.02.067-.01.098.004zm-6.246 9.185l12.28-5.237s.018 0 .035.017c.067.067.124.112.179.154l.027.017c.025.014.05.03.052.056 0 .01 0 .016-.002.025L25.756 23.7l-.004.026c-.007.05-.014.107-.061.107a1.729 1.729 0 0 0-1.373.847l-.005.008c-.014.023-.027.045-.05.057-.021.01-.048.006-.07.001l-9.793-2.02c-.01-.002-.152-.519-.163-.52z"/> +</svg> +\ No newline at end of file diff --git a/src/media/railway.png b/src/media/railway.png Binary files differ. diff --git a/src/media/render.svg b/src/media/render.svg @@ -0,0 +1 @@ +<svg xmlns="http://www.w3.org/2000/svg" width="1em" height="1em" viewBox="0 0 24 24"><path fill="currentColor" d="M18.263.007c-3.121-.147-5.744 2.109-6.192 5.082c-.018.138-.045.272-.067.405c-.696 3.703-3.936 6.507-7.827 6.507a7.9 7.9 0 0 1-3.825-.979a.202.202 0 0 0-.302.178V24H12v-8.999c0-1.656 1.338-3 2.987-3h2.988c3.382 0 6.103-2.817 5.97-6.244c-.12-3.084-2.61-5.603-5.682-5.75"/></svg> +\ No newline at end of file diff --git a/src/media/replit.svg b/src/media/replit.svg @@ -0,0 +1 @@ +<svg xmlns="http://www.w3.org/2000/svg" width="0.84em" height="1em" viewBox="0 0 256 308"><path fill="#f26207" d="M0 19.2C0 8.596 8.596 0 19.2 0h89.6C119.404 0 128 8.596 128 19.2v83.2H19.2C8.596 102.4 0 93.804 0 83.2zm128 83.2h108.8c10.604 0 19.2 8.596 19.2 19.2v64c0 10.604-8.596 19.2-19.2 19.2H128zM0 224c0-10.604 8.596-19.2 19.2-19.2H128V288c0 10.604-8.596 19.2-19.2 19.2H19.2C8.596 307.2 0 298.604 0 288z"/></svg> +\ No newline at end of file diff --git a/src/media/resources.svg b/src/media/resources.svg @@ -0,0 +1,133 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" + "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"> +<svg version="1.0" xmlns="http://www.w3.org/2000/svg" + width="512.000000pt" height="512.000000pt" viewBox="0 0 512.000000 512.000000" + preserveAspectRatio="xMidYMid meet"> + +<g transform="translate(0.000000,512.000000) scale(0.100000,-0.100000)" +fill="#FFFFFF" stroke="none"> +<path d="M3471 4943 c-16 -13 -31 -53 -54 -142 l-32 -123 -61 -23 c-33 -12 +-78 -32 -100 -43 l-40 -20 -108 64 c-70 42 -118 64 -138 64 -27 0 -51 -19 +-165 -133 -114 -114 -133 -138 -133 -165 0 -20 22 -67 64 -138 l65 -107 -21 +-40 c-11 -23 -31 -68 -43 -101 l-23 -61 -123 -32 c-157 -41 -159 -43 -159 +-169 l0 -94 80 0 80 0 0 49 0 49 110 27 c61 15 119 35 129 44 11 9 29 48 41 +86 12 39 40 105 61 148 22 43 39 87 39 98 0 12 -27 67 -61 122 l-60 100 69 69 +69 69 100 -60 c55 -34 110 -61 122 -61 11 0 55 17 98 39 43 21 110 49 148 61 +39 12 77 30 86 41 9 10 29 68 44 129 l27 110 98 0 98 0 27 -110 c15 -61 35 +-119 44 -129 9 -11 48 -29 86 -41 39 -12 105 -40 148 -61 43 -22 87 -39 98 +-39 12 0 67 27 122 61 l100 60 69 -69 69 -69 -60 -100 c-34 -55 -61 -110 -61 +-122 0 -12 17 -56 39 -99 21 -42 48 -108 61 -147 12 -38 30 -77 41 -86 10 -9 +68 -29 129 -44 l110 -27 0 -98 0 -98 -110 -27 c-61 -15 -119 -35 -129 -44 -11 +-9 -29 -47 -41 -86 -12 -38 -40 -105 -61 -148 -22 -43 -39 -87 -39 -98 0 -12 +27 -67 61 -122 l60 -100 -69 -69 -69 -69 -100 60 c-55 34 -110 61 -122 61 -11 +0 -55 -17 -98 -39 -43 -21 -109 -49 -148 -61 -38 -12 -77 -30 -86 -41 -9 -10 +-29 -68 -44 -129 l-27 -110 -98 0 -98 0 -27 110 c-15 61 -35 119 -44 129 -9 +11 -47 29 -86 41 -38 13 -100 37 -137 56 l-67 33 -27 -47 c-15 -26 -34 -57 +-41 -69 -14 -21 -12 -23 49 -54 34 -17 90 -42 123 -54 l60 -23 32 -123 c23 +-89 38 -129 54 -141 18 -16 45 -18 209 -18 164 0 191 2 209 17 16 13 31 53 54 +142 l32 124 50 17 c28 10 73 29 101 43 l51 26 107 -65 c64 -38 119 -64 135 +-64 23 0 56 27 165 133 119 115 136 136 136 164 0 21 -21 67 -64 139 l-65 107 +21 40 c11 23 31 68 43 101 l23 61 123 32 c89 23 129 38 142 54 15 18 17 45 17 +209 0 164 -2 191 -17 209 -13 16 -53 31 -142 54 l-124 32 -17 50 c-10 28 -29 +73 -43 101 l-26 51 65 107 c42 71 64 118 64 138 0 27 -19 51 -133 165 -114 +114 -138 133 -165 133 -20 0 -67 -22 -138 -64 l-107 -65 -51 26 c-28 14 -73 +33 -101 43 l-50 17 -32 124 c-23 89 -38 129 -54 142 -18 15 -45 17 -209 17 +-164 0 -191 -2 -209 -17z"/> +<path d="M3540 4386 c-216 -46 -404 -189 -499 -378 -61 -123 -76 -190 -75 +-338 1 -107 5 -137 27 -205 38 -115 90 -198 182 -290 131 -131 277 -199 454 +-212 434 -30 796 330 767 765 -6 107 -43 228 -97 320 -49 82 -180 211 -262 +257 -148 82 -343 113 -497 81z m246 -157 c163 -29 320 -149 393 -302 99 -204 +74 -423 -69 -602 -49 -62 -55 -62 -108 -13 -26 25 -56 49 -67 56 -17 9 -18 14 +-8 29 7 10 25 41 40 68 27 49 28 54 28 215 l0 165 -34 63 c-38 69 -80 110 +-151 144 -66 32 -196 31 -265 -2 -63 -31 -124 -91 -155 -155 -24 -47 -25 -60 +-25 -215 0 -161 1 -166 28 -215 15 -27 33 -58 40 -68 10 -16 8 -21 -13 -35 +-14 -10 -44 -34 -67 -55 -48 -44 -53 -43 -108 22 -103 125 -148 317 -111 475 +38 163 151 304 299 375 119 58 226 73 353 50z m-18 -336 c37 -27 61 -63 68 +-100 6 -29 4 -33 -14 -33 -11 0 -42 18 -67 40 -31 27 -56 40 -75 40 -19 0 -44 +-13 -75 -40 -47 -40 -85 -52 -85 -26 0 47 45 109 95 132 40 19 119 12 153 -13z +m-56 -263 c18 -11 55 -23 81 -26 48 -7 49 -7 43 -38 -7 -37 -32 -72 -70 -100 +-39 -29 -133 -29 -172 0 -38 28 -63 63 -70 100 -6 31 -5 31 43 38 26 3 62 15 +78 25 17 11 31 20 32 20 2 1 17 -8 35 -19z m65 -366 c58 -20 136 -71 130 -87 +-2 -6 -28 -19 -58 -30 -76 -28 -252 -30 -329 -3 -74 25 -81 33 -50 57 93 73 +207 97 307 63z"/> +<path d="M1467 3897 c-19 -18 -28 -51 -50 -187 -15 -90 -29 -164 -30 -165 -6 +-2 -213 -87 -222 -91 -6 -2 -71 38 -145 91 -108 77 -140 95 -169 95 -33 0 -50 +-15 -223 -188 -173 -173 -188 -190 -188 -223 0 -29 18 -61 95 -169 53 -74 93 +-139 91 -145 -4 -9 -89 -216 -91 -222 -1 -1 -75 -15 -165 -30 -136 -22 -169 +-31 -187 -50 -23 -22 -23 -25 -23 -293 0 -268 0 -271 23 -293 18 -19 51 -28 +187 -50 90 -15 164 -29 165 -30 2 -6 87 -213 91 -222 2 -6 -38 -71 -91 -145 +-77 -108 -95 -140 -95 -169 0 -33 15 -50 188 -223 173 -173 190 -188 223 -188 +29 0 61 18 169 95 74 53 139 93 145 91 9 -4 216 -89 222 -91 1 -1 15 -75 30 +-165 22 -136 31 -169 50 -187 22 -23 25 -23 293 -23 329 0 307 -10 333 150 42 +250 33 226 80 240 23 6 75 27 116 46 86 39 58 49 233 -77 161 -115 140 -121 +370 109 173 173 188 190 188 223 0 29 -18 61 -95 169 -53 74 -93 139 -91 145 +4 9 89 216 91 222 1 1 75 15 165 30 136 22 169 31 187 50 23 22 23 25 23 293 +0 268 0 271 -23 293 -18 19 -51 28 -187 50 -90 15 -164 29 -165 30 -2 6 -87 +213 -91 222 -2 6 38 71 91 145 77 108 95 140 95 169 0 33 -15 50 -188 223 +-230 230 -209 224 -370 109 -175 -126 -147 -116 -233 -77 -41 19 -93 40 -116 +46 -47 14 -38 -10 -80 240 -26 160 -4 150 -333 150 -268 0 -271 0 -293 -23z +m467 -154 c2 -10 15 -81 27 -158 18 -111 27 -144 43 -158 12 -10 60 -31 108 +-47 48 -16 124 -48 169 -70 52 -26 89 -40 103 -36 11 3 77 46 146 95 l125 90 +122 -121 122 -122 -46 -65 c-26 -36 -67 -93 -90 -126 -24 -33 -46 -70 -49 -81 +-4 -14 10 -52 36 -103 22 -45 54 -121 70 -169 16 -48 37 -96 47 -108 14 -16 +47 -25 158 -43 77 -12 148 -25 158 -27 15 -5 17 -22 17 -174 0 -152 -2 -169 +-17 -174 -10 -2 -79 -14 -153 -26 -74 -12 -144 -28 -156 -35 -14 -9 -30 -42 +-47 -97 -14 -46 -47 -125 -72 -177 -29 -59 -44 -103 -41 -115 3 -12 46 -77 95 +-146 l90 -125 -121 -122 -122 -122 -65 46 c-36 26 -93 67 -126 90 -33 24 -69 +46 -81 49 -12 3 -57 -13 -115 -41 -52 -25 -131 -58 -177 -72 -55 -17 -88 -33 +-97 -47 -7 -12 -23 -82 -35 -156 -12 -74 -24 -143 -26 -152 -5 -16 -22 -18 +-174 -18 -152 0 -169 2 -174 18 -2 9 -15 80 -27 157 -18 111 -27 144 -43 158 +-12 10 -60 31 -108 47 -48 16 -123 48 -167 70 -45 22 -87 40 -95 40 -11 0 -99 +-58 -257 -171 l-25 -18 -122 122 -121 122 90 125 c49 69 92 135 95 146 4 14 +-10 51 -36 103 -22 45 -54 121 -70 169 -16 48 -37 96 -47 108 -14 16 -47 25 +-158 43 -77 12 -148 25 -157 27 -16 5 -18 22 -18 174 0 152 2 169 18 174 9 2 +80 15 157 27 111 18 144 27 158 43 10 12 31 60 47 108 16 48 48 124 70 169 26 +52 40 89 36 103 -3 11 -46 77 -95 146 l-90 125 121 122 122 122 25 -18 c158 +-113 246 -171 257 -171 8 0 50 18 95 40 44 22 119 54 167 70 48 16 96 37 108 +47 16 14 25 47 43 158 12 77 25 148 27 158 5 15 22 17 174 17 152 0 169 -2 +174 -17z"/> +<path d="M1603 3266 c-393 -75 -680 -347 -775 -733 -44 -182 -24 -403 53 -589 +197 -474 756 -706 1238 -513 284 113 497 361 573 666 31 124 31 322 0 446 -90 +360 -370 636 -723 713 -102 22 -277 27 -366 10z m347 -169 c209 -57 368 -171 +480 -344 196 -300 163 -698 -80 -973 l-40 -45 -155 78 -155 77 0 53 c0 50 3 +57 46 102 26 26 60 78 78 114 l31 66 0 215 0 215 -32 67 c-44 93 -100 151 +-191 196 -72 35 -81 37 -172 37 -91 0 -100 -2 -172 -37 -91 -45 -147 -103 +-191 -196 l-32 -67 0 -215 0 -215 32 -67 c17 -37 52 -88 77 -113 43 -43 46 +-49 46 -100 l0 -55 -155 -78 -156 -77 -35 40 c-204 232 -263 517 -168 806 88 +268 325 470 619 528 67 13 257 6 325 -12z m-116 -309 c26 -8 60 -31 91 -63 57 +-56 75 -102 75 -189 0 -54 -1 -56 -20 -46 -11 6 -34 37 -50 70 -48 96 -91 105 +-170 35 -61 -54 -117 -84 -187 -101 l-53 -12 0 55 c0 86 18 132 75 188 70 71 +145 90 239 63z m121 -457 c30 -8 45 -17 45 -27 0 -108 -125 -224 -240 -224 +-115 0 -240 116 -240 223 0 10 11 19 28 22 93 19 155 40 208 69 l59 33 47 -42 +c30 -27 64 -47 93 -54z m-115 -431 c0 -17 -14 -40 -40 -65 l-40 -39 -40 39 +c-26 25 -40 48 -40 65 0 25 1 25 80 25 79 0 80 0 80 -25z m-184 -230 c97 -94 +111 -94 209 1 l73 70 106 -53 c58 -29 106 -56 106 -60 0 -12 -105 -56 -190 +-81 -58 -16 -103 -21 -200 -21 -97 0 -142 5 -200 21 -85 25 -190 69 -190 81 0 +6 193 109 209 111 3 1 37 -30 77 -69z"/> +<path d="M3707 2218 c-17 -17 -28 -53 -46 -146 -21 -110 -26 -124 -48 -133 +-19 -7 -32 -2 -72 26 -27 19 -51 35 -54 35 -7 0 -91 -130 -86 -134 2 -2 39 +-27 82 -55 89 -60 101 -61 201 -18 86 37 93 47 118 175 l22 112 96 0 96 0 22 +-112 c25 -128 32 -138 118 -175 102 -44 111 -43 210 24 49 33 94 62 100 66 6 +3 41 -24 77 -61 l67 -67 -65 -97 c-36 -54 -65 -108 -65 -122 0 -21 30 -100 62 +-163 13 -27 35 -35 161 -58 l97 -19 0 -96 0 -96 -97 -19 c-126 -23 -148 -31 +-161 -58 -32 -63 -62 -142 -62 -163 0 -14 29 -68 65 -122 l65 -97 -67 -67 +c-36 -37 -71 -64 -77 -61 -6 4 -50 33 -98 65 -48 32 -98 58 -111 58 -22 0 +-100 -30 -164 -62 -27 -13 -35 -35 -58 -161 l-19 -97 -96 0 -96 0 -19 98 c-23 +125 -31 147 -58 160 -64 32 -142 62 -164 62 -13 0 -63 -26 -111 -58 -48 -32 +-92 -61 -98 -65 -6 -3 -41 24 -77 61 l-67 67 65 97 c36 54 65 108 65 122 0 21 +-30 100 -62 163 -6 12 -26 27 -43 33 -51 17 -275 58 -279 51 -8 -14 -29 -141 +-24 -146 2 -3 53 -15 112 -27 148 -29 149 -34 56 -173 -99 -147 -101 -138 63 +-302 164 -164 155 -162 304 -62 141 95 142 94 174 -73 34 -176 21 -168 259 +-168 238 0 225 -8 259 168 32 166 34 167 176 72 147 -99 138 -101 302 63 164 +164 162 155 63 302 -94 141 -94 142 71 175 177 35 169 22 169 260 0 238 8 225 +-169 260 -165 33 -165 34 -71 175 99 147 101 138 -63 302 -164 164 -155 162 +-302 63 -142 -95 -144 -94 -176 72 -34 176 -21 168 -259 168 -185 0 -192 -1 +-213 -22z"/> +<path d="M3801 1664 c-253 -68 -410 -331 -346 -579 50 -190 207 -330 401 -358 +329 -48 612 266 529 586 -67 259 -333 419 -584 351z m254 -175 c63 -30 123 +-90 155 -154 35 -71 35 -197 0 -270 -31 -64 -91 -124 -155 -155 -73 -35 -199 +-35 -270 0 -64 31 -124 91 -155 155 -35 71 -35 197 0 270 42 86 123 152 215 +176 54 14 156 3 210 -22z"/> +</g> +</svg> diff --git a/src/media/vercel.svg b/src/media/vercel.svg @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"> +<svg version="1.0" xmlns="http://www.w3.org/2000/svg" width="512.000000pt" height="512.000000pt" viewBox="0 0 512.000000 512.000000" preserveAspectRatio="xMidYMid meet"> +<metadata> +Created by potrace 1.11, written by Peter Selinger 2001-2013 +</metadata> +<g transform="translate(0.000000,512.000000) scale(0.100000,-0.100000)" fill="#FFFFF" stroke="none"> +<path d="M2310 5109 c-502 -55 -974 -249 -1355 -556 -129 -104 -340 -321 -433 -445 -265 -354 -434 -758 -498 -1193 -22 -147 -29 -428 -15 -575 42 -433 180 -833 405 -1174 414 -629 1047 -1032 1791 -1142 147 -22 428 -29 575 -15 433 42 833 180 1174 405 629 414 1032 1047 1142 1791 22 147 29 428 15 575 -51 524 -238 988 -558 1385 -104 129 -321 340 -445 433 -354 265 -755 432 -1193 498 -121 18 -487 26 -605 13z m909 -2348 c347 -607 631 -1105 631 -1107 0 -2 -569 -4 -1265 -4 -696 0 -1265 2 -1265 5 0 8 1263 2216 1266 2212 1 -1 287 -499 633 -1106z"/> +</g> +</svg> diff --git a/src/useful/domain-structure.md b/src/useful/domain-structure.md @@ -0,0 +1,268 @@ +--- +icon: file-code +route: /domain-structure +tags: useful +--- +# Domain Structure +To register a subdomain, you must create a new JSON file in the `domains` directory through a pull request. For example, to register `example.is-a.dev`, you would create a file named `example.json` in the `domains` directory. The full path would be `domains/example.json`. + +## Filename + +**Note**: You can include `.` (dots) in your filename to register a sub-subdomain (e.g., `blog.example.is-a.dev`). However, each segment of your subdomain must meet the following criteria: + +The filename: +- Must be alphanumeric, in lowercase. Dashes (`-`) may be used as separators, however they must *not* be consecutive (e.g. `--`). +- Must be at least 1 character. +- Must not be longer than 244 characters (excluding the file extension, `.json`). +- Each label (separated by fullstops, e.g. `test.example`) must not be longer than 63 characters. +- Must have a `.json` file extension. +- Must *not* contain `is-a.dev`. + +### Examples of Invalid Filenames +- `.json` (filename is less than 1 character) +- `A.json` (filename contains uppercase letters) +- `a..json` (filename contains consecutive dots) +- `.a.json` (filename starts with a dot) +- `a .json` (filename contains a space) +- `a$.json` (filename contains a non-alphanumeric character) +- `a.json.json` (filename contains more than one `.json` extension) +- `a.is-a.dev.json` (filename contains `.is-a.dev`) +- `a--a.json` (filename contains consecutive dashes) +- `blog._a.json` (root subdomain starts starts with an underscore) +- `abc123.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json` (one label is longer than 63 characters) +- `abc12abc12abc12abc12abc12abc1.2abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc.12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12abc12a.bc12abc12abc12abc12abc12abc12abc12abc12abc12.json` (file name is longer than 244 characters) + +### Examples of Valid Filenames +All the filenames below meet all the criteria. The reason in parentheses is just an example of one of the criteria they meet. + +- `a.json` (at least 1 character long) +- `example.json` (alphanumeric and in lowercase) +- `blog.example.json` (includes dots to register a sub-subdomain, also called a nested subdomain) +- `my-blog.json` (uses dashes as separators) +- `mail._domainkey.example.json` (root subdomain does not contain underscores) +- `_vercel.example.json` (root subdomain does not contain underscores) +- `abc123.json` (alphanumeric) + +**NOTE:** To stop a user from having a monopoly over one-lettered subdomains, we limit users to only one one-lettered subdomain. + +### Example JSON File +`domains/docs.json` + +```json +{ + "owner": { + "username": "is-a-dev", + "email": "admin@is-a.dev" + }, + "records": { + "CNAME": "is-a-dev-docs.pages.dev" + }, + "proxied": true +} +``` + +## Structure + +### `owner` (required) +You need to specify some information about yourself here. This is so that you can be contacted if required. +In the owner object, the fields `username` and `email` are required. You may add more information in this object if you want, such as a `discord` field. +```json +{ + "owner": { + "username": "your-github-username" + } +} +``` + +### `records` (required) +This section is where you specify the DNS records. + +You can see a list of supported record types [here](./faq#which-records-are-supported). + +Below are some examples for the given record types: + +- **`CNAME`** record: This must be a hostname (`something.tld`). It cannot be used in conjunction with any other record types unless your domain is proxied (see [proxying your domain](https://docs.is-a.dev/domain-structure/#proxied-optional)). This is typically used to map your domain to a specific server. +```json +{ + "records": { + "CNAME": "github-username.github.io" + } +} +``` +- **`A`** record: This must be a list of IPv4 addresses. These addresses point your domain to a specific server. +```json +{ + "records": { + "A": [ + "192.0.2.1", + "198.51.100.1", + "203.0.113.1" + ] + } +} +``` +- **`AAAA`** record: This must be a list of IPv6 addresses. Like the A record, these addresses point your domain to a specific server. +```json +{ + "records": { + "AAAA": [ + "2001:0db8:85a3:0000:0000:8a2e:0370:7334", + "2001:0db8:85a3:0000:0000:8a2e:0370:7335", + "2001:0db8:85a3:0000:0000:8a2e:0370:7336" + ] + } +} +``` +- **`URL`** record: This redirects your domain to another URL. +```json +{ + "records": { + "URL": "https://example.com" + } +} +``` +- **`MX`** record: This must be a list of hostnames. These hostnames specify the mail servers that handle emails for your domain. +```json +{ + "records": { + "MX": [ + "mx1.improvmx.com", + "mx2.improvmx.com" + ] + } +} +``` +```json +{ + "records": { + "MX": [ + { + "target": "mx1.improvmx.com", + "priority": 10 + }, + { + "target": "mx2.improvmx.com", + "priority": 20 + } + ] + } +} +``` +- **`TLSA`** record: This record is used to store the fingerprint of a TLS/SSL certificate associated with a service. It helps in securing the connection by allowing clients to verify the server's certificate against the information stored in DNS. +```json +{ + "records": { + "TLSA": [ + { + "usage": 1, + "selector": 1, + "matchingType": 1, + "certificate": "5B2D3A4F5E6B7C8D9E0F1A2B3C4D5E6F7A8B9C0D1E2F3A4B5C6D7E8F9A0B1C2D3" + } + ] + } +} +``` +- **`TXT`** record: This can be either a single string or a list of strings. TXT records are often used for various purposes, such as verifying domain ownership and ensuring email security. +```json +{ + "records": { + "TXT": "Hello World!" + } +} +``` +```json +{ + "records": { + "TXT": ["Hello", "World!"] + } +} +``` +- **`NS`** record: This must be a list of hostnames. These hostnames specify the authoritative DNS servers for your domain. +```json +{ + "records": { + "NS": [ + "ns1.example.com", + "ns2.example.com" + ] + } +} +``` +Note: Please refer to the [frequently asked questions](https://docs.is-a.dev/faq/) for clarification on what or who we allow NS records for. If you want a example on what we want as the reasonings, you can [checkout this PR](https://github.com/is-a-dev/register/pull/16758). + +- **`SRV`** record: This must be a list of service records. Each record specifies the priority, weight, port, and target for a service on your domain. SRV records are often used for services such as VoIP, messaging, Minecraft, and more. +```json +{ + "records": { + "SRV": [ + { + "priority": 10, + "weight": 5, + "port": 8080, + "target": "srv.example.com" + }, + { + "priority": 20, + "weight": 10, + "port": 9090, + "target": "srv2.example.com" + } + ] + } +} +``` +- **`CAA`** record: This must be a list of Certification Authority Authorization (CAA) records. Each record specifies the authority permitted to issue SSL certificates for your domain, with fields for `flags`, `tag`, and `value`. +```json +{ + "records": { + "CAA": [ + { + "flags": 0, + "tag": "issue", + "value": "letsencrypt.org" + }, + { + "flags": 0, + "tag": "issuewild", + "value": "comodoca.com" + } + ] + } +} +``` +- **`DS`** record: This must be a list of Delegation Signer(DS) records. Each verifies the authenticity of the (subdomain) zone with field `key_tag`, `algorithm`, `digest_type` and `digest`. +```json +"DS": [{ + "key_tag": 2371, + "algorithm": 13, + "digest_type": 2, + "digest": "C2074462471B81206F792AEC23469EF33DDC53538E8580DCCC92FD130C9A6096" + }] +``` +### `services` (*optional*) +This section is for the verification records of certain services. Here is an example of all currently available options: +```json +"services": { + "discord": "dh=examplestring123", + "vercel": "vc-domain-verify=example.is-a.dev,example123", + "bluesky": "did=did:plc:example123" +} +``` + +### `proxied` (*optional*) +Enable Cloudflare proxy for your domain. This is disabled by default. To enable it, add this line of code: +```json +"proxied": true +``` + +### `redirect_config` (*optional*) +- Allows custom redirect endpoints for your domain. An example can be found [here](https://github.com/is-a-dev/register/blob/main/domains/william.json). +```json +"redirect_config": { + "custom_paths": { + "/github": "https://github.com/wdhdev" + }, + "redirect_paths": true +} +``` diff --git a/src/useful/faq.md b/src/useful/faq.md @@ -0,0 +1,93 @@ +--- +icon: question +label: FAQ +route: /faq +tags: useful +--- +# Frequently Asked Questions (FAQ) + +## Which records are supported? + +- A +- AAAA +- CAA +- CNAME +- DS + - Note: These can only be used in combination with NS records, which are used for DNSSEC. +- MX +- NS + - Note: These are only given out in specific cases. Refer to [`Who can use NS records?`](#who-can-use-ns-records) for more information. +- SRV +- TLSA +- TXT +- URL + - Note: These records use Cloudflare for redirection, it is not a real DNS record type. + +## Why does my domain still redirect to the is-a.dev website? +This usually occurs due to the cache of your browser becoming invalid and [clearing your browser's cache](https://support.google.com/accounts/answer/32050) should solve this issue. + +## Can I use a CNAME record with any other records? +You cannot request a subdomain nor submit changes containing a CNAME with any other records (A, AAAA, MX, TXT, etc...) unless the domain is proxied. For information on how to proxy a domain, see [proxying your domain](https://docs.is-a.dev/domain-structure/#proxied-optional). + +## How long will it take for my pull request to get merged? +When we get to it. We always try to shorten users' wait time as much as possible; however, maintainers have lives and cannot always be online. We have school and work; this is just a side project. Remember that all the maintainers are volunteers. Be patient and we'll get to it as soon as possible! For a chance of a quicker review, send your your pull request link in [#⁠pull-requests](https://discord.com/channels/830872854677422150/1130858271620726784) on our [Discord server](https://discord.gg/is-a-dev-830872854677422150). + +## Which services do you support? +We support nearly all services, however these are the main services people use with is-a.dev: + +- Cloudflare Pages +- GitHub Pages +- Netlify +- Railway +- Vercel + +## Can I create nested subdomains? (sub-sub domains) +Yes, you can! Simply create a file such as `blog.example.json` and follow the same guidelines as you would while registering `example.json`. Please note in order to have `blog.example.is-a.dev`, you must also own `example.is-a.dev`. Additionally, you can nest subdomains as much as you can — `example.example.example.is-a.dev` is possible. + +## I get an SSL error while using GitHub Pages, how do I fix this? +Visit your GitHub Pages settings on your website's repository (most likely labelled similar to `your-github-username.github.io`) and ensure the `Enforce HTTPS` option is enabled to avoid this error. + +## Can I become a maintainer/join the is-a.dev staff team? +No, we handpick each member of the team. You can increase your chances of being chosen by helping out people in our help forums and channels. This alone, however, will not guarantee in any way a position in the team. + +## I have accidentally leaked sensitive information in my PR, how can I get my PR deleted? +If your PR **has not been merged**, email [security@is-a.dev](mailto:security@is-a.dev) or DM [@williamharrison on Discord](https://discord.com/users/853158265466257448). If your PR has been merged already, then there is unfortunately nothing we can do about it. + +## Can I use my domain for a Minecraft server? +Yes, you can. You can use an A record combined with an SRV record for this. + +Refer to [this article](https://www.namecheap.com/support/knowledgebase/article.aspx/9765/2208/how-can-i-link-my-domain-name-to-a-minecraft-server) by Namecheap for support. + +Please note that you may only do this on a *nested subdomain*, as root subdomains must be related to software development as is required in our [Terms of Service](https://is-a.dev/terms). + +## Who can use NS records? +We permit NS records for the following reasons: + +- The DNS record types we already support are not sufficient for your use case. **Evidence must be provided for your use case and why you require them.** +- When a provider (e.g. Aternos) requires NS delegation, where they maintain the DNS zone, not you. **Supporting documentation must be provided.** + +We do not permit NS records for: + +- Convenience-only setups: Where alternatives such as A, AAAA, or CNAME records are sufficient. +- Non-operational purposes +- Lack of evidence for need of use +- Misleading evidence +- Security risks + +***We reserve the right to deny NS records at our discretion, no matter the reasoning.*** + +## Why are you so strict with NS records? +We have to be strict with who we delegate NS records to as they allow the end-user to essentially do *whatever they wish* with their subdomain. + +As you can probably imagine, this opens the door to a lot of abuse, which is why they are not freely available to everyone. + +## How can I make changes to or delete my is-a.dev subdomain? +1. **Read this documentation and our [ToS](https://is-a.dev/terms)**: This is so that you can ensure you fully understand the registration process, our requirements, and how to fully comply with our Terms of Service. +2. **Open your JSON file:** Navigate to the `domains` directory in your fork and open the JSON file corresponding to your subdomain (`domains/your-subdomain.json`). +3. **Make your changes:** Edit or delete the JSON file to reflect the changes you want to make. +4. **Commit your changes:** Once you've made your changes, commit them to your fork. +5. **Push your changes:** Push your changes to your forked repository on GitHub. +6. **Submit a pull request:** Navigate to your forked repository on GitHub and open a pull request. +7. **Wait for your PR to be merged:** After you have submitted your pull request, wait for it to be reviewed and merged. Once your pull request has been merged, your changes should be live! + +**Note:** Make sure to monitor your PR for reviews in case some changes are requested by a maintainer. diff --git a/src/useful/index.yml b/src/useful/index.yml @@ -0,0 +1 @@ +icon: star +\ No newline at end of file diff --git a/src/useful/resources.md b/src/useful/resources.md @@ -0,0 +1,36 @@ +--- +icon: browser +route: /resources +tags: useful +--- + +# Resources +This page provides a collection of resources to help you understand key concepts related to domain management, such as DNS, records, and more. + +## Asking For Help +- [How do I ask a good question?](https://stackoverflow.com/help/how-to-ask) - A guide on how to ask a good question by Stack Overflow. +- [How To Ask Questions The Smart Way](http://catb.org/~esr/faqs/smart-questions.html) - A long and comprehensive guide on asking questions the smart way by Eric Steven Raymond and Rick Moen. +- [Don't Ask to Ask](https://dontasktoask.com) - When asking for support, ask your question directly. This makes everyones' lives easier, including yours! + +## JSON +- [JSON for Beginners](https://www.freecodecamp.org/news/what-is-json-a-json-file-example/) - JavaScript Object Notation (JSON) Explained in Plain English by Tapas Adhikary. +- [JSON Formatter](https://jsonformatter.org/) - A JSON formatter and validator. +- [JSON Explained](https://www.youtube.com/watch?v=cj3h3Fb10QY) - A video on JSON by Hostinger Academy. + +## Domain Name System (DNS) +- [What is DNS?](https://www.cloudflare.com/learning/dns/what-is-dns/) - A beginner-friendly introduction to DNS from Cloudflare. +- [How DNS Works](https://howdns.works/) - A fun and colorful explanation of how DNS works using a comic. +- [DNS Explained](https://www.youtube.com/watch?v=72snZctFFtA) - A video explanation of DNS on YouTube. + +## DNS Records +- [Understanding DNS Record Types](https://www.cloudflare.com/learning/dns/dns-records/) - A guide to different types of DNS records from Cloudflare. +- [DNS Record Types](https://wizardzines.com/comics/dns-record-types/) - An explanation of common DNS record types using a comic. +- [DNS Records Explained](https://www.youtube.com/watch?v=VMKbwYMoxX4) - A video explanation of DNS records. + +## Git and GitHub +- [The Simple Guide to Git](https://rogerdudler.github.io/git-guide/) - A simple guide to Git without any deep shit. +- [Think Like a Git](https://think-like-a-git.net/) - A guide for understanding Git. + +## Other +- [How to Clear Browser Cache](https://www.hostinger.com/tutorials/clear-browser-cache) - A simple guide on clearing browser cache in popular browsers. +- [How HTTPS Works](https://howhttps.works/) - An explanation of HTTPS using a comic.