├── .gitignore ├── LICENSE ├── Package.resolved ├── Package.swift ├── README.md └── Sources └── swift-web └── app.swift /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | /.build 3 | /Packages 4 | /*.xcodeproj 5 | xcuserdata/ 6 | DerivedData/ 7 | .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata 8 | .vscode/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2021 Adam Fowler 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Package.resolved: -------------------------------------------------------------------------------- 1 | { 2 | "pins" : [ 3 | { 4 | "identity" : "async-http-client", 5 | "kind" : "remoteSourceControl", 6 | "location" : "https://github.com/swift-server/async-http-client.git", 7 | "state" : { 8 | "revision" : "0a9b72369b9d87ab155ef585ef50700a34abf070", 9 | "version" : "1.23.1" 10 | } 11 | }, 12 | { 13 | "identity" : "hummingbird", 14 | "kind" : "remoteSourceControl", 15 | "location" : "https://github.com/hummingbird-project/hummingbird.git", 16 | "state" : { 17 | "revision" : "70b0714b4c4a192a51a9ddcc691fcf2ab3bc9141", 18 | "version" : "2.5.0" 19 | } 20 | }, 21 | { 22 | "identity" : "swift-algorithms", 23 | "kind" : "remoteSourceControl", 24 | "location" : "https://github.com/apple/swift-algorithms", 25 | "state" : { 26 | "revision" : "f6919dfc309e7f1b56224378b11e28bab5bccc42", 27 | "version" : "1.2.0" 28 | } 29 | }, 30 | { 31 | "identity" : "swift-argument-parser", 32 | "kind" : "remoteSourceControl", 33 | "location" : "https://github.com/apple/swift-argument-parser.git", 34 | "state" : { 35 | "revision" : "41982a3656a71c768319979febd796c6fd111d5c", 36 | "version" : "1.5.0" 37 | } 38 | }, 39 | { 40 | "identity" : "swift-async-algorithms", 41 | "kind" : "remoteSourceControl", 42 | "location" : "https://github.com/apple/swift-async-algorithms.git", 43 | "state" : { 44 | "revision" : "5c8bd186f48c16af0775972700626f0b74588278", 45 | "version" : "1.0.2" 46 | } 47 | }, 48 | { 49 | "identity" : "swift-atomics", 50 | "kind" : "remoteSourceControl", 51 | "location" : "https://github.com/apple/swift-atomics.git", 52 | "state" : { 53 | "revision" : "cd142fd2f64be2100422d658e7411e39489da985", 54 | "version" : "1.2.0" 55 | } 56 | }, 57 | { 58 | "identity" : "swift-collections", 59 | "kind" : "remoteSourceControl", 60 | "location" : "https://github.com/apple/swift-collections.git", 61 | "state" : { 62 | "revision" : "671108c96644956dddcd89dd59c203dcdb36cec7", 63 | "version" : "1.1.4" 64 | } 65 | }, 66 | { 67 | "identity" : "swift-distributed-tracing", 68 | "kind" : "remoteSourceControl", 69 | "location" : "https://github.com/apple/swift-distributed-tracing.git", 70 | "state" : { 71 | "revision" : "6483d340853a944c96dbcc28b27dd10b6c581703", 72 | "version" : "1.1.2" 73 | } 74 | }, 75 | { 76 | "identity" : "swift-http-types", 77 | "kind" : "remoteSourceControl", 78 | "location" : "https://github.com/apple/swift-http-types.git", 79 | "state" : { 80 | "revision" : "ef18d829e8b92d731ad27bb81583edd2094d1ce3", 81 | "version" : "1.3.1" 82 | } 83 | }, 84 | { 85 | "identity" : "swift-log", 86 | "kind" : "remoteSourceControl", 87 | "location" : "https://github.com/apple/swift-log.git", 88 | "state" : { 89 | "revision" : "9cb486020ebf03bfa5b5df985387a14a98744537", 90 | "version" : "1.6.1" 91 | } 92 | }, 93 | { 94 | "identity" : "swift-metrics", 95 | "kind" : "remoteSourceControl", 96 | "location" : "https://github.com/apple/swift-metrics.git", 97 | "state" : { 98 | "revision" : "e0165b53d49b413dd987526b641e05e246782685", 99 | "version" : "2.5.0" 100 | } 101 | }, 102 | { 103 | "identity" : "swift-nio", 104 | "kind" : "remoteSourceControl", 105 | "location" : "https://github.com/apple/swift-nio.git", 106 | "state" : { 107 | "revision" : "914081701062b11e3bb9e21accc379822621995e", 108 | "version" : "2.76.1" 109 | } 110 | }, 111 | { 112 | "identity" : "swift-nio-extras", 113 | "kind" : "remoteSourceControl", 114 | "location" : "https://github.com/apple/swift-nio-extras.git", 115 | "state" : { 116 | "revision" : "2e9746cfc57554f70b650b021b6ae4738abef3e6", 117 | "version" : "1.24.1" 118 | } 119 | }, 120 | { 121 | "identity" : "swift-nio-http2", 122 | "kind" : "remoteSourceControl", 123 | "location" : "https://github.com/apple/swift-nio-http2.git", 124 | "state" : { 125 | "revision" : "eaa71bb6ae082eee5a07407b1ad0cbd8f48f9dca", 126 | "version" : "1.34.1" 127 | } 128 | }, 129 | { 130 | "identity" : "swift-nio-ssl", 131 | "kind" : "remoteSourceControl", 132 | "location" : "https://github.com/apple/swift-nio-ssl.git", 133 | "state" : { 134 | "revision" : "c7e95421334b1068490b5d41314a50e70bab23d1", 135 | "version" : "2.29.0" 136 | } 137 | }, 138 | { 139 | "identity" : "swift-nio-transport-services", 140 | "kind" : "remoteSourceControl", 141 | "location" : "https://github.com/apple/swift-nio-transport-services.git", 142 | "state" : { 143 | "revision" : "bbd5e63cf949b7db0c9edaf7a21e141c52afe214", 144 | "version" : "1.23.0" 145 | } 146 | }, 147 | { 148 | "identity" : "swift-numerics", 149 | "kind" : "remoteSourceControl", 150 | "location" : "https://github.com/apple/swift-numerics.git", 151 | "state" : { 152 | "revision" : "0a5bc04095a675662cf24757cc0640aa2204253b", 153 | "version" : "1.0.2" 154 | } 155 | }, 156 | { 157 | "identity" : "swift-service-context", 158 | "kind" : "remoteSourceControl", 159 | "location" : "https://github.com/apple/swift-service-context.git", 160 | "state" : { 161 | "revision" : "0c62c5b4601d6c125050b5c3a97f20cce881d32b", 162 | "version" : "1.1.0" 163 | } 164 | }, 165 | { 166 | "identity" : "swift-service-lifecycle", 167 | "kind" : "remoteSourceControl", 168 | "location" : "https://github.com/swift-server/swift-service-lifecycle.git", 169 | "state" : { 170 | "revision" : "f70b838872863396a25694d8b19fe58bcd0b7903", 171 | "version" : "2.6.2" 172 | } 173 | }, 174 | { 175 | "identity" : "swift-system", 176 | "kind" : "remoteSourceControl", 177 | "location" : "https://github.com/apple/swift-system.git", 178 | "state" : { 179 | "revision" : "c8a44d836fe7913603e246acab7c528c2e780168", 180 | "version" : "1.4.0" 181 | } 182 | } 183 | ], 184 | "version" : 2 185 | } 186 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:5.9 2 | import PackageDescription 3 | 4 | let package = Package( 5 | name: "swift-web", 6 | platforms : [.macOS(.v14)], 7 | products: [.executable(name: "swift-web", targets: ["swift-web"])], 8 | dependencies: [ 9 | .package(url: "https://github.com/hummingbird-project/hummingbird.git", from: "2.0.0"), 10 | .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.3.0") 11 | ], 12 | targets: [ 13 | .executableTarget( 14 | name: "swift-web", 15 | dependencies: [ 16 | .product(name: "ArgumentParser", package: "swift-argument-parser"), 17 | .product(name: "Hummingbird", package: "hummingbird"), 18 | ] 19 | ), 20 | ] 21 | ) 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # swift-web 2 | 3 | A web server serving local static files. 4 | 5 | ## Installation 6 | 7 | ### Using Mint 8 | 9 | The easiest way to install swift-web is via [mint](https://github.com/yonaskolb/Mint). 10 | 11 | ```sh 12 | mint install adam-fowler/swift-web 13 | ``` 14 | 15 | ### Using Swift Package Manager 16 | 17 | ```sh 18 | git clone https://github.com/adam-fowler/swift-web 19 | swift build -c release 20 | ``` 21 | And then copy `.build/release/swift-web` to a folder in your $PATH 22 | 23 | ## Running 24 | 25 | To serve files from the current folder run 26 | 27 | ```sh 28 | swift web 29 | ``` 30 | 31 | This will run a web server bound to port 8001. Type `localhost:8001/` into your web browser to view a file. 32 | 33 | To serve files from a particular folder run 34 | 35 | ```sh 36 | swift web 37 | ``` 38 | 39 | You can also change the port the server uses with the `--port` option. 40 | 41 | ```sh 42 | swift web --port 8080 43 | ``` 44 | -------------------------------------------------------------------------------- /Sources/swift-web/app.swift: -------------------------------------------------------------------------------- 1 | import ArgumentParser 2 | import Hummingbird 3 | import Logging 4 | 5 | @main 6 | struct WebServer: AsyncParsableCommand { 7 | @Option(name: .shortAndLong) 8 | var hostname: String = "127.0.0.1" 9 | 10 | @Option(name: .shortAndLong) 11 | var port: Int = 8001 12 | 13 | @Argument 14 | var folder: String = "." 15 | 16 | func run() async throws { 17 | let logger = Logger(label: "swift-web") 18 | let router = Router() 19 | router.middlewares.add(FileMiddleware(self.folder, searchForIndexHtml: true, logger: logger)) 20 | router.middlewares.add(LogRequestsMiddleware(.info)) 21 | let app = Application( 22 | router: router, 23 | configuration: .init( 24 | address: .hostname(self.hostname, port: self.port), 25 | serverName: "swift-web" 26 | ), 27 | logger: logger 28 | ) 29 | try await app.runService() 30 | } 31 | } 32 | --------------------------------------------------------------------------------