git.iko.soy/obelisk
on ae@no-hardcoded-frontend help sign in
obelisk/README.md
358 lines 17 kB history raw
1# Obelisk
3Obelisk provides an easy way to develop and deploy your [Reflex](https://github.com/reflex-frp/reflex) project as web apps and as mobile apps.
5- [Installing Obelisk](#installing-obelisk)
6- [Developing an Obelisk project](#developing-an-obelisk-project)
7 - [Adding Packages](#adding-packages)
8 - [Adding Package Overrides](#adding-package-overrides)
9 - [Running over https](#running-over-https)
10- [Deploying](#deploying)
11 - [Locally](#locally)
12 - [EC2](#ec2)
13 - [From macOS](#from-macos)
14 - [Deploying an updated version](#deploying-an-updated-version)
15- [Mobile](#mobile)
16 - [iOS](#ios)
17 - [Android](#android)
19## Installing Obelisk
201. [Install Nix](https://nixos.org/nix/).
21 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
221. Set up nix caches
23 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:
24 ```
25 nix.binaryCaches = [ "https://nixcache.reflex-frp.org" ];
26 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];
27 ```
28 and rebuild your NixOS configuration (e.g. `sudo nixos-rebuild switch`).
29 1. If you are using another operating system or linux distribution, ensure that these lines are present in your Nix configuration file (`/etc/nix/nix.conf` on most systems; [see full list](https://nixos.org/nix/manual/#sec-conf-file)):
30 ```
31 binary-caches = https://cache.nixos.org https://nixcache.reflex-frp.org
32 binary-cache-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
33 binary-caches-parallel-connections = 40
34 ```
35 * other Linux: enable sandboxing (see these [issue172](https://github.com/obsidiansystems/obelisk/issues/172#issuecomment-411507818) or [issue6](https://github.com/obsidiansystems/obelisk/issues/6) if you run into build problems)
36 ```
37 sandbox = true
38 ```
39 * MacOS: disable sandboxing (there are still some impure dependencies for now)
40 ```
41 sandbox = false
42 ```
43 then restart the nix daemon
44 ```
45 sudo launchctl stop org.nixos.nix-daemon
46 sudo launchctl start org.nixos.nix-daemon
47 ```
481. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`
50### Contributing to Obelisk
52When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:
54```
55nix-shell -A obeliskEnvs.obelisk-backend --run "cd lib/backend && ghcid -c 'cabal new-repl'"
56```
58Or to launch ghcid for `lib/command` project:
60```
61nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid -c 'cabal new-repl'"
62```
64To re-install `ob` from source do
65```
66nix-env -f /path/to/obelisk -iA command
67```
69Note that `ob` will defer to the version found in your project's `.obelisk/impl` directory. To update that version specifically:
71```shell
72ob thunk unpack ./.obelisk/impl
73cd ./.obelisk/impl
74# apply your changes
75```
77If you want to commit your changes, first push them to your fork of obelisk and then
79```shell
80cd /your/project/root
81ob thunk pack .obelisk/impl
82git add .obelisk/impl
83git commit -m "Bump obelisk"
84```
86### Accessing private repositories
88To allow the Nix builder to access private git repositories, you must be set up
89to access them via SSH. Follow these steps depending on the platform you need
90access to:
92- [GitHub](https://help.github.com/articles/connecting-to-github-with-ssh/)
93- [GitLab](https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html)
95## Developing an Obelisk project
97To create a new Obelisk project, go to an empty directory and run:
99```
100ob init
101```
103Obelisk leverages ghcid to provide a live-reloading server that handles both frontend and backend. To run your Obelisk app and monitor the source for changes:
105```
106ob run
107```
109Now, with an appropriate browser, go to http://localhost:8000 (or the address/port specified in `config/common/route`) to access your app.
110Firefox will not be able to properly run the development website due to [issue 460](https://github.com/obsidiansystems/obelisk/issues/460). Fortunately, this problem does not occur on a fully built website.
112Every time you change the Haskell source files in frontend, common or backend, `ob run` will automatically recompile the modified files and reload the server. Furthermore, it will display on screen compilation errors and warnings if any.
114### Adding packages
116In order to add package dependencies, declare them under the build-depends field in the appropriate cabal files (backend, common, and frontend each have their own). The corresponding Nix packages will automatically be selected when building.
118### Adding package overrides
120To add a version override to any Haskell package, or to add a Haskell package that doesn't exist in the nixpkgs used by Obelisk, use the `overrides` attribute in your project's `default.nix`. For example, to use a specific version of the `aeson` package fetched from GitHub and a specific version of the `waargonaut` package fetched from Hackage, your `default.nix` will look like:
122```nix
123# ...
124project ./. ({ pkgs, ... }: {
125# ...
126 overrides = self: super: let
127 aesonSrc = pkgs.fetchFromGitHub {
128 owner = "obsidiansystems";
129 repo = "aeson-gadt-th";
130 rev = "ed573c2cccf54d72aa6279026752a3fecf9c1383";
131 sha256 = "08q6rnz7w9pn76jkrafig6f50yd0f77z48rk2z5iyyl2jbhcbhx3";
132 };
133 in
134 {
135 aeson = self.callCabal2nix "aeson" aesonSrc {};
136 waargonaut = self.callHackageDirect {
137 pkg = "waargonaut";
138 ver = "0.8.0.1";
139 sha256 = "1zv28np3k3hg378vqm89v802xr0g8cwk7gy3mr77xrzy5jbgpa39";
140 } {};
141 };
142# ...
143```
145For further information see [the Haskell section](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) of nixpkgs Contributors Guide.
147### Adding extra local packages
149If the standard packages (`frontend`, `backend`, and `common`) are not
150enough, to add more local Haskell packages, define them with the
151`packages` parameter. The sources of these packages will be
152automatically reloaded by `ob run`.
154```nix
155# ...
156project ./. ({ pkgs, ... }: {
157# ...
158 packages = {
159 another = ./another;
160 };
161# ...
162```
164### Running over https
166To run your app locally over https, update the protocol in `config/common/route` to `https`, and then use `ob run` as normal.
168Since Obelisk generates a self-signed certificate for running https, the browser will issue a warning about using an invalid certificate. On Chrome, you can go to `chrome://flags/#allow-insecure-localhost` to enable invalid certificates for localhost.
170## Deploying
172### Locally
174Build everything:
176```
177nix-build -A exe --no-out-link
178```
180Copy the result to a new directory, add configuration, and run!
182```
183mkdir test-app
184ln -s $(nix-build -A exe --no-out-link)/* test-app/
185cp -r config test-app
186(cd test-app && ./backend)
187```
189### EC2
191In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance.
193First create a new EC2 instance:
1951. Launch a NixOS 19.09 EC2 instance (we recommend [this AMI](https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#LaunchInstanceWizard:ami=ami-00a8eeaf232a74f84))
1961. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
1971. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.
1981. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and 443.
200At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.
202Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
203Your project directory must be "thunkable", i.e. something on which `ob thunk pack` can be called. Usually it will be a git repository whose current revision has been pushed upstream.
205```
206cd ~/code/myapp
207SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com
208ROUTE=https://myapp.com # Publicly accessible route to your app
209EMAIL=myname@myapp.com
210ob deploy init \
211 --ssh-key ~/myaws.pem \
212 --hostname $SERVER \
213 --route $ROUTE \
214 --admin-email $EMAIL \
215 ~/code/myapp-deploy
216```
218HTTPS is enabled by default; to disable https, pass `--disable-https` to the `ob deploy init` command above.
220This step will also require that you manually verify the authenticity of the host `$SERVER`. Obelisk will save the fingerprint in a deployment-specific configuration. **Obelisk deployments do *not* rely on the `known_hosts` of your local machine.** This is because, in the event that you need to switch from one deploy machine / bastion host to another, you want to be absolutely sure that you're still connecting to the machines you think you are, even if that deploy machine / bastion host has never connected to them before. Obelisk explicitly avoids a workflow that encourages people to accept host keys without checking them, since that could result in leaking production secrets to anyone who manages to MITM you, e.g. via DNS spoofing or cache poisoning. (Note that an active attack is a circumstance where you may need to quickly switch bastion hosts, e.g. because the attacker has taken one down or you have taken it down in case it was compromised. In this circumstance you might need to deploy to production to fix an exploit or rotate keys, etc.) When you run `ob deploy` later it will rely on the saved verification in this step.
222Next, go to the deployment directory that you just initialized and deploy!
224```
225cd ~/code/myapp-deploy
226ob deploy push
227```
229`ob deploy push` will locally build your app and then transfer it, along with all the Nix package dependencies, via ssh to the EC2 instance. The backend will live in `/var/lib/backend`.
231At this point you are done. Your app will be accessible at `${ROUTE}`. The currently deployed version - the git commit hash of the source repo - can be found at `${ROUTE}/version`.
233### From macOS
235Deploying from macOS requires some extra setup:
237- [Install nix-darwin](https://github.com/LnL7/nix-darwin)
238- [Install docker](https://docs.docker.com/)
240Running `ob deploy push` will give you additional setup instructions.
242### Deploying an updated version
244If you'd like to deploy an updated version (with new commits) of your Obelisk app: simply go to the configuration directory, update the source thunk and push:
246```
247cd ~/code/myapp-deploy
248ob deploy update
249ob deploy push
250```
252## Mobile
253Until Obelisk offers a `ob deploy` equivalent for mobile apps, you are recommended to do it manually as follows.
255### iOS
257#### First time setup
258Development on iOS requires a computer running macOS and an iOS developer account.
259Your account must also belong to an Apple Developer Team, if you want to access developer portal links (otherwise they'll redirect to your account page).
261##### iPhone
2621. Connect the iPhone on which you'd like to run builds - this will open up iTunes.
2631. Click accept to authorize on both the computer and the iPhone.
265##### Xcode
266Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
268These versions will work out of the box but iOS SDKs prior to 11.3 should also work. You can choose another installed version in `default.nix`
270More recent Xcodes should also work, as long as one of the SDKs mentioned above has been used.
271To add another SDK to your current Xcode, [download](https://developer.apple.com/download/more/) the corresponding Xcode, extract it and copy its SDK folder next to the installed one, e.g.
272```
273open -W Xcode_9.2.xip
274sudo cp -R Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS11.2.sdk
275```
278You can verify that you have correct versions by running
279```
280xcodebuild -showsdks
281```
283##### Certificates
284To deploy and/or package apps, you'll need to inform Apple of your development devices and permissions by
285adding credentials to the correct provisioning profile via the Apple Developer portal.
2871. Open up XCode and go to Preferences - Accounts. Select the organization
288Member role, click Manage Certificates, and add an iOS Development
289certificate.
2901. Go to [developer portal - devices](https://developer.apple.com/account/ios/device/) and add your device.
291To find your device's UDID, select it in iTunes and click the serial number.
2921. Go to [developer portal - development profiles](https://developer.apple.com/account/ios/profile/limited).
293Create a development profile and add your certificate and device.
294Click "Generate" and then download and open the profile.
296#### Building
2971. In your project's `default.nix` set values for `ios.bundleIdentifier` and `ios.bundleName`.
298Ensure that `bundleIdentifier` matches the App ID of the development profile, or that you are using a wildcard profile.
2991. Run `nix-build -A ios.frontend -o result-ios` to build the app. Find it at `result-ios/frontend.app`
301#### Deploying
3021. Connect the registered iPhone.
3031. Find your Apple Team ID in the [developer portal](https://developer.apple.com/account/#/membership).
3041. Run the deploy command with your Team ID:
305```
306result-ios/bin/deploy [TEAM_ID]
307# or in debug mode via lldb:
308result-ios/bin/deploy [TEAM_ID] -d
309```
311#### Packaging
3121. Go to [developer portal - distribution profiles](https://developer.apple.com/account/ios/profile/production).
313Create and download a distribution profile.
3141. Run the package script with your TEAM ID and your distribution profile to create a `.ipa`:
315```
316result-ios/bin/package [TEAM_ID] /path/to/output/.ipa /path/to/profile/file
317```
319#### Debugging
320It's also possible to inspect iOS WkWebView apps once they are installed in the iPhone:
3211. On the desktop, go to Safari > Preferences > Advanced and enable Develop menu.
3221. On the iPhone go to Settings > Safari > Advanced and enable Web Inspector.
3231. Open the app on the iPhone while it is connected to the desktop.
3241. In the desktop's Safari Develop menu, you should see your iPhone. Select the screen under the name of the app.
326### Android
328NOTE: Currently Android builds are only supported on Linux.
3301. In your project's `default.nix` set a suitable value for `android.applicationId` and `android.displayName`.
3311. In your project's `default.nix` pass `config.android_sdk.accept_license = true;` in the arguments to the import of of `.obelisk/impl` to indicate your acceptance of the [Android Software Development Kit License Agreement](https://developer.android.com/studio/terms), which is required to build Android apps.
3321. Run `nix-build -A android.frontend -o result-android` to build the Android app.
3331. A debug version of the app should be generated at `result-android/android-app-debug.apk`
335Now deploy the built apk file to your Android device:
3371. Enable *USB debugging* in your Android device ([instructions here](https://developer.android.com/studio/debug/dev-options))
3381. Connect the device using USB (be sure to confirm any security prompts on the device)
3391. Run the deploy script: `result-android/bin/deploy`
341Alternatively, you can deploy from an obelisk deployment directory (a directory generated post `ob deploy init ...` command) using the `ob deploy test android` command.
342This command will accomplish the following:
3441. Create a key store and apk signing key (`android_keystore.jks`)
3451. Build a Signed Android apk for your application
3461. Deploy the Signed apk to your connected Android device
348In the event that you change your key or keystore password, you will have to update your credentials within the JSON object found in `android_keytool_config.json`.
350Additional documentation on Java key stores can be found [here](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html).
352This should copy over and install the application on your device (if you see a "*signatures do not match*" error, simply uninstall the previous app from the device before retrying the deploy). The name of the installed application will be what you have specified for `android.displayName` in the `default.nix`.
354#### Releasing to Play Store
356##### Build a release version
358After having configured signing for your app, you may proceed to build a release version of the app. This is no different to how you build the non-release version, so consult the section [Android](#android) further above for exact instructions on building and deploying to your device.