git.iko.soy/obelisk
on deprecated-optparse-function help sign in
obelisk/README.md
340 lines 16 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 Packages](#adding-packages)
9 - [Adding Package Overrides](#adding-package-overrides)
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://cache.nixos.org/" "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 substituters = https://cache.nixos.org https://nixcache.reflex-frp.org
32 trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
33 ```
34 * 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)
35 ```
36 sandbox = true
37 ```
38 * MacOS: disable sandboxing (there are still some impure dependencies for now)
39 ```
40 sandbox = false
41 ```
42 then restart the nix daemon
43 ```
44 sudo launchctl stop org.nixos.nix-daemon
45 sudo launchctl start org.nixos.nix-daemon
46 ```
471. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`
49### Contributing to Obelisk
51When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:
53```
54nix-shell -A obeliskEnvs.obelisk-backend --run "cd lib/backend && ghcid -c 'cabal new-repl'"
55```
57Or to launch ghcid for `lib/command` project:
59```
60nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid -c 'cabal new-repl'"
61```
63To re-install `ob` from source do
64```
65nix-env -f /path/to/obelisk -iA command
66```
68Note that `ob` will defer to the version found in your project's `.obelisk/impl` directory. To update that version specifically:
70```shell
71ob thunk unpack ./obelisk/impl
72cd ./obelisk/impl
73# apply your changes
74```
76If you want to commit your changes, first push them to your fork of obelisk and then
78```shell
79cd /your/project/root
80ob thunk pack .obelisk/impl
81git add .obelisk/impl
82git commit -m "Bump obelisk"
83```
85### Accessing private repositories
87To allow the Nix builder to access private git repositories, you must be set up
88to access them via SSH. Follow these steps depending on the platform you need
89access to:
91- [GitHub](https://help.github.com/articles/connecting-to-github-with-ssh/)
92- [GitLab](https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html)
94## Developing an Obelisk project
96To create a new Obelisk project, go to an empty directory and run:
98```
99ob init
100```
102Obelisk 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:
104```
105ob run
106```
108Now, with an appropriate browser, go to http://localhost:8000 (or the address/port specified in `config/common/route`) to access your app.
109Firefox 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.
111Every 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.
113### Hoogle
115To enter a nix-shell from which you can run the hoogle command-line client or a hoogle server for your project:
117`nix-shell -A shells.ghc --arg withHoogle true`
119### Adding packages
121In 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.
123### Adding package overrides
125To 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:
127```nix
128# ...
129project ./. ({ pkgs, ... }: {
130# ...
131 overrides = self: super: let
132 aesonSrc = pkgs.fetchFromGitHub {
133 owner = "obsidiansystems";
134 repo = "aeson-gadt-th";
135 rev = "ed573c2cccf54d72aa6279026752a3fecf9c1383";
136 sha256 = "08q6rnz7w9pn76jkrafig6f50yd0f77z48rk2z5iyyl2jbhcbhx3";
137 };
138 in
139 {
140 aeson = self.callCabal2nix "aeson" aesonSrc {};
141 waargonaut = self.callHackageDirect {
142 pkg = "waargonaut";
143 ver = "0.8.0.1";
144 sha256 = "1zv28np3k3hg378vqm89v802xr0g8cwk7gy3mr77xrzy5jbgpa39";
145 } {};
146 };
147# ...
148```
150For further information see [the Haskell section](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) of nixpkgs Contributors Guide.
152## Deploying
154### Locally
156Build everything:
158```
159nix-build -A exe --no-out-link
160```
162Copy the result to a new directory, add configuration, and run!
164```
165mkdir test-app
166ln -s $(nix-build -A exe --no-out-link)/* test-app/
167cp -r config test-app
168(cd test-app && ./backend)
169```
171### EC2
173In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance.
175First create a new EC2 instance:
1771. 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))
1781. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
1791. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.
1801. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and 443.
182At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.
184Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
185Your 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.
187```
188cd ~/code/myapp
189SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com
190ROUTE=https://myapp.com # Publicly accessible route to your app
191EMAIL=myname@myapp.com
192ob deploy init \
193 --ssh-key ~/myaws.pem \
194 --hostname $SERVER \
195 --route $ROUTE \
196 --admin-email $EMAIL \
197 ~/code/myapp-deploy
198```
200HTTPS is enabled by default; to disable https, pass `--disable-https` to the `ob deploy init` command above.
202This 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.
204Next, go to the deployment directory that you just initialized and deploy!
206```
207cd ~/code/myapp-deploy
208ob deploy push
209```
211`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`.
213At 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`.
215### From macOS
217Deploying from macOS requires some extra setup:
219- [Install nix-darwin](https://github.com/LnL7/nix-darwin)
220- [Install docker](https://docs.docker.com/)
222Running `ob deploy push` will give you additional setup instructions.
224### Deploying an updated version
226If 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:
228```
229cd ~/code/myapp-deploy
230ob deploy update
231ob deploy push
232```
234## Mobile
235Until Obelisk offers a `ob deploy` equivalent for mobile apps, you are recommended to do it manually as follows.
237### iOS
239#### First time setup
240Development on iOS requires a computer running macOS and an iOS developer account.
241Your 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).
243##### iPhone
2441. Connect the iPhone on which you'd like to run builds - this will open up iTunes.
2451. Click accept to authorize on both the computer and the iPhone.
247##### Xcode
248Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
250These 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`
252More recent Xcodes should also work, as long as one of the SDKs mentioned above has been used.
253To 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.
254```
255open -W Xcode_9.2.xip
256sudo 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
257```
260You can verify that you have correct versions by running
261```
262xcodebuild -showsdks
263```
265##### Certificates
266To deploy and/or package apps, you'll need to inform Apple of your development devices and permissions by
267adding credentials to the correct provisioning profile via the Apple Developer portal.
2691. Open up XCode and go to Preferences - Accounts. Select the organization
270Member role, click Manage Certificates, and add an iOS Development
271certificate.
2721. Go to [developer portal - devices](https://developer.apple.com/account/ios/device/) and add your device.
273To find your device's UDID, select it in iTunes and click the serial number.
2741. Go to [developer portal - development profiles](https://developer.apple.com/account/ios/profile/limited).
275Create a development profile and add your certificate and device.
276Click "Generate" and then download and open the profile.
278#### Building
2791. In your project's `default.nix` set values for `ios.bundleIdentifier` and `ios.bundleName`.
280Ensure that `bundleIdentifier` matches the App ID of the development profile, or that you are using a wildcard profile.
2811. Run `nix-build -A ios.frontend -o result-ios` to build the app. Find it at `result-ios/frontend.app`
283#### Deploying
2841. Connect the registered iPhone.
2851. Find your Apple Team ID in the [developer portal](https://developer.apple.com/account/#/membership).
2861. Run the deploy command with your Team ID:
287```
288result-ios/bin/deploy [TEAM_ID]
289# or in debug mode via lldb:
290result-ios/bin/deploy [TEAM_ID] -d
291```
293#### Packaging
2941. Go to [developer portal - distribution profiles](https://developer.apple.com/account/ios/profile/production).
295Create and download a distribution profile.
2961. Run the package script with your TEAM ID and your distribution profile to create a `.ipa`:
297```
298result-ios/bin/package [TEAM_ID] /path/to/output/.ipa /path/to/profile/file
299```
301#### Debugging
302It's also possible to inspect iOS WkWebView apps once they are installed in the iPhone:
3031. On the desktop, go to Safari > Preferences > Advanced and enable Develop menu.
3041. On the iPhone go to Settings > Safari > Advanced and enable Web Inspector.
3051. Open the app on the iPhone while it is connected to the desktop.
3061. In the desktop's Safari Develop menu, you should see your iPhone. Select the screen under the name of the app.
308### Android
310NOTE: Currently Android builds are only supported on Linux.
3121. In your project's `default.nix` set a suitable value for `android.applicationId` and `android.displayName`.
3131. 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.
3141. Run `nix-build -A android.frontend -o result-android` to build the Android app.
3151. A debug version of the app should be generated at `result-android/android-app-debug.apk`
317Now deploy the built apk file to your Android device:
3191. Enable *USB debugging* in your Android device ([instructions here](https://developer.android.com/studio/debug/dev-options))
3201. Connect the device using USB (be sure to confirm any security prompts on the device)
3211. Run the deploy script: `result-android/bin/deploy`
323Alternatively, you can deploy from an obelisk deployment directory (a directory generated post `ob deploy init ...` command) using the `ob deploy test android` command.
324This command will accomplish the following:
3261. Create a key store and apk signing key (`android_keystore.jks`)
3271. Build a Signed Android apk for your application
3281. Deploy the Signed apk to your connected Android device
330In 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`.
332Additional documentation on Java key stores can be found [here](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html).
334This 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`.
336#### Releasing to Play Store
338##### Build a release version
340After 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.