git.iko.soy/obelisk
on v0.3 help sign in
obelisk/README.md
347 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 - [Hoogle](#hoogle)
8 - [Adding Packages](#adding-packages)
9 - [Adding Package Overrides](#adding-package-overrides)
10 - [Running over https](#running-over-https)
11- [Deploying](#deploying)
12 - [Locally](#locally)
13 - [EC2](#ec2)
14 - [From macOS](#from-macos)
15 - [Deploying an updated version](#deploying-an-updated-version)
16- [Mobile](#mobile)
17 - [iOS](#ios)
18 - [Android](#android)
20## Installing Obelisk
211. [Install Nix](https://nixos.org/nix/).
22 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
231. Set up nix caches
24 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:
25 ```
26 nix.binaryCaches = [ "https://cache.nixos.org/" "https://nixcache.reflex-frp.org" ];
27 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];
28 ```
29 and rebuild your NixOS configuration (e.g. `sudo nixos-rebuild switch`).
30 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)):
31 ```
32 substituters = https://cache.nixos.org https://nixcache.reflex-frp.org
33 trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
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### Hoogle
116To enter a nix-shell from which you can run the hoogle command-line client or a hoogle server for your project:
118`nix-shell -A shells.ghc --arg withHoogle true`
120### Adding packages
122In 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.
124### Adding package overrides
126To 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:
128```nix
129# ...
130project ./. ({ pkgs, ... }: {
131# ...
132 overrides = self: super: let
133 aesonSrc = pkgs.fetchFromGitHub {
134 owner = "obsidiansystems";
135 repo = "aeson-gadt-th";
136 rev = "ed573c2cccf54d72aa6279026752a3fecf9c1383";
137 sha256 = "08q6rnz7w9pn76jkrafig6f50yd0f77z48rk2z5iyyl2jbhcbhx3";
138 };
139 in
140 {
141 aeson = self.callCabal2nix "aeson" aesonSrc {};
142 waargonaut = self.callHackageDirect {
143 pkg = "waargonaut";
144 ver = "0.8.0.1";
145 sha256 = "1zv28np3k3hg378vqm89v802xr0g8cwk7gy3mr77xrzy5jbgpa39";
146 } {};
147 };
148# ...
149```
151For further information see [the Haskell section](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) of nixpkgs Contributors Guide.
153### Running over https
155To run your app locally over https, update the protocol in `config/common/route` to `https`, and then use `ob run` as normal.
157Since 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.
159## Deploying
161### Locally
163Build everything:
165```
166nix-build -A exe --no-out-link
167```
169Copy the result to a new directory, add configuration, and run!
171```
172mkdir test-app
173ln -s $(nix-build -A exe --no-out-link)/* test-app/
174cp -r config test-app
175(cd test-app && ./backend)
176```
178### EC2
180In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance.
182First create a new EC2 instance:
1841. 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))
1851. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
1861. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.
1871. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and 443.
189At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.
191Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
192Your 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.
194```
195cd ~/code/myapp
196SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com
197ROUTE=https://myapp.com # Publicly accessible route to your app
198EMAIL=myname@myapp.com
199ob deploy init \
200 --ssh-key ~/myaws.pem \
201 --hostname $SERVER \
202 --route $ROUTE \
203 --admin-email $EMAIL \
204 ~/code/myapp-deploy
205```
207HTTPS is enabled by default; to disable https, pass `--disable-https` to the `ob deploy init` command above.
209This 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.
211Next, go to the deployment directory that you just initialized and deploy!
213```
214cd ~/code/myapp-deploy
215ob deploy push
216```
218`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`.
220At 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`.
222### From macOS
224Deploying from macOS requires some extra setup:
226- [Install nix-darwin](https://github.com/LnL7/nix-darwin)
227- [Install docker](https://docs.docker.com/)
229Running `ob deploy push` will give you additional setup instructions.
231### Deploying an updated version
233If 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:
235```
236cd ~/code/myapp-deploy
237ob deploy update
238ob deploy push
239```
241## Mobile
242Until Obelisk offers a `ob deploy` equivalent for mobile apps, you are recommended to do it manually as follows.
244### iOS
246#### First time setup
247Development on iOS requires a computer running macOS and an iOS developer account.
248Your 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).
250##### iPhone
2511. Connect the iPhone on which you'd like to run builds - this will open up iTunes.
2521. Click accept to authorize on both the computer and the iPhone.
254##### Xcode
255Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
257These 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`
259More recent Xcodes should also work, as long as one of the SDKs mentioned above has been used.
260To 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.
261```
262open -W Xcode_9.2.xip
263sudo 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
264```
267You can verify that you have correct versions by running
268```
269xcodebuild -showsdks
270```
272##### Certificates
273To deploy and/or package apps, you'll need to inform Apple of your development devices and permissions by
274adding credentials to the correct provisioning profile via the Apple Developer portal.
2761. Open up XCode and go to Preferences - Accounts. Select the organization
277Member role, click Manage Certificates, and add an iOS Development
278certificate.
2791. Go to [developer portal - devices](https://developer.apple.com/account/ios/device/) and add your device.
280To find your device's UDID, select it in iTunes and click the serial number.
2811. Go to [developer portal - development profiles](https://developer.apple.com/account/ios/profile/limited).
282Create a development profile and add your certificate and device.
283Click "Generate" and then download and open the profile.
285#### Building
2861. In your project's `default.nix` set values for `ios.bundleIdentifier` and `ios.bundleName`.
287Ensure that `bundleIdentifier` matches the App ID of the development profile, or that you are using a wildcard profile.
2881. Run `nix-build -A ios.frontend -o result-ios` to build the app. Find it at `result-ios/frontend.app`
290#### Deploying
2911. Connect the registered iPhone.
2921. Find your Apple Team ID in the [developer portal](https://developer.apple.com/account/#/membership).
2931. Run the deploy command with your Team ID:
294```
295result-ios/bin/deploy [TEAM_ID]
296# or in debug mode via lldb:
297result-ios/bin/deploy [TEAM_ID] -d
298```
300#### Packaging
3011. Go to [developer portal - distribution profiles](https://developer.apple.com/account/ios/profile/production).
302Create and download a distribution profile.
3031. Run the package script with your TEAM ID and your distribution profile to create a `.ipa`:
304```
305result-ios/bin/package [TEAM_ID] /path/to/output/.ipa /path/to/profile/file
306```
308#### Debugging
309It's also possible to inspect iOS WkWebView apps once they are installed in the iPhone:
3101. On the desktop, go to Safari > Preferences > Advanced and enable Develop menu.
3111. On the iPhone go to Settings > Safari > Advanced and enable Web Inspector.
3121. Open the app on the iPhone while it is connected to the desktop.
3131. In the desktop's Safari Develop menu, you should see your iPhone. Select the screen under the name of the app.
315### Android
317NOTE: Currently Android builds are only supported on Linux.
3191. In your project's `default.nix` set a suitable value for `android.applicationId` and `android.displayName`.
3201. 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.
3211. Run `nix-build -A android.frontend -o result-android` to build the Android app.
3221. A debug version of the app should be generated at `result-android/android-app-debug.apk`
324Now deploy the built apk file to your Android device:
3261. Enable *USB debugging* in your Android device ([instructions here](https://developer.android.com/studio/debug/dev-options))
3271. Connect the device using USB (be sure to confirm any security prompts on the device)
3281. Run the deploy script: `result-android/bin/deploy`
330Alternatively, you can deploy from an obelisk deployment directory (a directory generated post `ob deploy init ...` command) using the `ob deploy test android` command.
331This command will accomplish the following:
3331. Create a key store and apk signing key (`android_keystore.jks`)
3341. Build a Signed Android apk for your application
3351. Deploy the Signed apk to your connected Android device
337In 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`.
339Additional documentation on Java key stores can be found [here](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html).
341This 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`.
343#### Releasing to Play Store
345##### Build a release version
347After 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.