git.iko.soy/obelisk
on kiln help sign in
obelisk/README.md
303 lines 14 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 - [Hoogle](#hoogle)
8 - [Adding Package Overrides](#adding-package-overrides)
9- [Deploying](#deploying)
10 - [Locally](#locally)
11 - [EC2](#ec2)
12 - [From macOS](#from-macos)
13 - [Deploying an updated version](#deploying-an-updated-version)
14- [Mobile](#mobile)
15 - [iOS](#ios)
16 - [Android](#android)
18## Installing Obelisk
191. [Install Nix](https://nixos.org/nix/).
20 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
211. Set up nix caches
22 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:
23 ```
24 nix.binaryCaches = [ "https://cache.nixos.org/" "https://nixcache.reflex-frp.org" ];
25 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];
26 ```
27 and rebuild your NixOS configuration (e.g. `sudo nixos-rebuild switch`).
28 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)):
29 ```
30 substituters = https://cache.nixos.org https://nixcache.reflex-frp.org
31 trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
32 ```
33 * 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)
34 ```
35 sandbox = true
36 ```
37 * MacOS: disable sandboxing (there are still some impure dependencies for now)
38 ```
39 sandbox = false
40 ```
41 then restart the nix daemon
42 ```
43 sudo launchctl stop org.nixos.nix-daemon
44 sudo launchctl start org.nixos.nix-daemon
45 ```
461. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`
48### Contributing to Obelisk
50When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:
52```
53nix-shell -A obeliskEnvs.obelisk-backend --run "cd lib/backend && ghcid -c 'cabal new-repl'"
54```
56Or to launch ghcid for `lib/command` project:
58```
59nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid -c 'cabal new-repl'"
60```
62### Accessing private repositories
64To allow the Nix builder to access private git repositories, you must be set up
65to access them via SSH. Follow these steps depending on the platform you need
66access to:
68- [GitHub](https://help.github.com/articles/connecting-to-github-with-ssh/)
69- [GitLab](https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html)
71## Developing an Obelisk project
73To create a new Obelisk project, go to an empty directory and run:
75```
76ob init
77```
79Obelisk 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:
81```
82ob run
83```
85Now go to http://localhost:8000 (or the address/port specified in `config/common/route`) to access your app.
87Every 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.
89### Hoogle
91To enter a nix-shell from which you can run the hoogle command-line client or a hoogle server for your project:
93`nix-shell -A shells.ghc --arg withHoogle true`
95### Adding package overrides
97To 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, your `default.nix` will look like:
99```nix
100# ...
101project ./. ({ pkgs, ... }: {
102# ...
103 overrides = self: super: let
104 aeson = pkgs.fetchFromGitHub {
105 owner = "obsidiansystems";
106 repo = "aeson-gadt-th";
107 rev = "ed573c2cccf54d72aa6279026752a3fecf9c1383";
108 sha256 = "08q6rnz7w9pn76jkrafig6f50yd0f77z48rk2z5iyyl2jbhcbhx3";
109 };
110 in
111 {
112 aeson = self.callCabal2nix "aeson" aeson {};
113 };
114# ...
115```
117For further information see [the Haskell section](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) of nixpkgs Contributors Guide.
119## Deploying
121### Locally
123Build everything:
125```
126nix-build -A exe -o result-exe
127```
129Run the server:
131```
132cd result-exe
133./backend
134```
136### EC2
138In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance.
140First create a new EC2 instance:
1421. Launch a NixOS 18.09 EC2 instance (we recommend [this AMI](https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#LaunchInstanceWizard:ami=ami-009c9c3f1af480ff3))
1431. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
1441. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.
1451. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and 443.
147At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.
149Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
150Your 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.
152```
153cd ~/code/myapp
154SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com
155ROUTE=https://myapp.com # Publicly accessible route to your app
156EMAIL=myname@myapp.com
157ob deploy init \
158 --ssh-key ~/myaws.pem \
159 --hostname $SERVER \
160 --route $ROUTE \
161 --admin-email $EMAIL \
162 ~/code/myapp-deploy
163```
165NOTE: HTTPS is enabled by default; to disable https, pass `--disable-https` to the `ob deploy init` command above.
167Then go to that created deployment configuration directory, and initiate the deployment:
169```
170cd ~/code/myapp-deploy
171ob deploy push
172```
174`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`.
176At 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`.
178### From macOS
180Deploying from macOS requires some extra setup:
182- [Install nix-darwin](https://github.com/LnL7/nix-darwin)
183- [Install docker](https://docs.docker.com/)
185Running `ob deploy push` will give you additional setup instructions.
187### Deploying an updated version
189If 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:
191```
192cd ~/code/myapp-deploy
193ob deploy update
194ob deploy push
195```
197## Mobile
198Until Obelisk offers a `ob deploy` equivalent for mobile apps, you are recommended to do it manually as follows.
200### iOS
202#### First time setup
203Development on iOS requires a computer running macOS and an iOS developer account.
204Your 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).
206##### iPhone
2071. Connect the iPhone on which you'd like to run builds - this will open up iTunes.
2081. Click accept to authorize on both the computer and the iPhone.
210##### Xcode
211Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
213These 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`
215More recent Xcodes should also work, as long as one of the SDKs mentioned above has been used.
216To 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.
217```
218open -W Xcode_9.2.xip
219sudo 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
220```
223You can verify that you have correct versions by running
224```
225xcodebuild -showsdks
226```
228##### Certificates
229To deploy and/or package apps, you'll need to inform Apple of your development devices and permissions by
230adding credentials to the correct provisioning profile via the Apple Developer portal.
2321. Open up XCode and go to Preferences - Accounts. Select the organization
233Member role, click Manage Certificates, and add an iOS Development
234certificate.
2351. Go to [developer portal - devices](https://developer.apple.com/account/ios/device/) and add your device.
236To find your device's UDID, select it in iTunes and click the serial number.
2371. Go to [developer portal - development profiles](https://developer.apple.com/account/ios/profile/limited).
238Create a development profile and add your certificate and device.
239Click "Generate" and then download and open the profile.
241#### Building
2421. In your project's `default.nix` set values for `ios.bundleIdentifier` and `ios.bundleName`.
243Ensure that `bundleIdentifier` matches the App ID of the development profile, or that you are using a wildcard profile.
2441. Run `nix-build -A ios.frontend -o result-ios` to build the app. Find it at `result-ios/frontend.app`
246#### Deploying
2471. Connect the registered iPhone.
2481. Find your Apple Team ID in the [developer portal](https://developer.apple.com/account/#/membership).
2491. Run the deploy command with your Team ID:
250```
251result-ios/bin/deploy [TEAM_ID]
252# or in debug mode via lldb:
253result-ios/bin/deploy [TEAM_ID] -d
254```
256#### Packaging
2571. Go to [developer portal - distribution profiles](https://developer.apple.com/account/ios/profile/production).
258Create and download a distribution profile.
2591. Run the package script with your TEAM ID and your distribution profile to create a `.ipa`:
260```
261result-ios/bin/package [TEAM_ID] /path/to/output/.ipa /path/to/profile/file
262```
264#### Debugging
265It's also possible to inspect iOS WkWebView apps once they are installed in the iPhone:
2661. On the desktop, go to Safari > Preferences > Advanced and enable Develop menu.
2671. On the iPhone go to Settings > Safari > Advanced and enable Web Inspector.
2681. Open the app on the iPhone while it is connected to the desktop.
2691. In the desktop's Safari Develop menu, you should see your iPhone. Select the screen under the name of the app.
271### Android
273NOTE: Currently Android builds are only supported on Linux.
2751. In your project's `default.nix` set a suitable value for `android.applicationId` and `android.displayName`.
2761. 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.
2771. Run `nix-build -A android.frontend -o result-android` to build the Android app.
2781. A debug version of the app should be generated at `result-android/android-app-debug.apk`
280Now deploy the built apk file to your Android device:
2821. Enable *USB debugging* in your Android device ([instructions here](https://developer.android.com/studio/debug/dev-options))
2831. Connect the device using USB (be sure to confirm any security prompts on the device)
2841. Run the deploy script: `result-android/bin/deploy`
286Alternatively, you can deploy from an obelisk deployment directory (a directory generated post `ob deploy init ...` command) using the `ob deploy test android` command.
287This command will accomplish the following:
2891. Create a key store and apk signing key (`android_keystore.jks`)
2901. Build a Signed Android apk for your application
2911. Deploy the Signed apk to your connected Android device
293In 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`
295Additional documentation on java key stores can be found [here] (https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html)
297This 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`.
299#### Releasing to Play Store
301##### Build a release version
303After 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.