git.iko.soy/obelisk
on ob-upgrade-pr--hashLikeNix help sign in
obelisk/README.md
258 lines 12 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- [Deploying](#deploying)
8- [Mobile](#mobile)
9 - [iOS](#ios)
10 - [Android](#android)
12## Installing Obelisk
131. [Install Nix](https://nixos.org/nix/).
14 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
151. Set up nix caches
16 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:
17 ```
18 nix.binaryCaches = [ "https://cache.nixos.org/" "https://nixcache.reflex-frp.org" ];
19 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];
20 ```
21 1. If you are using another operating system or linux distribution, ensure that these lines are present in `/etc/nix/nix.conf`:
22 ```
23 sandbox = true
24 substituters = https://cache.nixos.org https://nixcache.reflex-frp.org
25 trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
26 ```
27 * If you are on MacOS, restart the nix daemon
28 ```
29 sudo launchctl stop org.nixos.nix-daemon
30 sudo launchctl start org.nixos.nix-daemon
31 ```
321. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`
34### Contributing to Obelisk
36When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:
38```
39nix-shell -A obelisk.obelisk-backend.env --run "cd lib/backend && ghcid -c 'cabal new-repl'"
40```
42Or to launch ghcid for `lib/command` project:
44```
45nix-shell -A obelisk.obelisk-command.env --run "cd lib/command && ghcid -c 'cabal new-repl'"
46```
48### Accessing private repositories
49To allow the Nix builder to access private git repositories, follow these steps:
511. [Get set up to connect to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
521. [Create a GitHub personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
531. Set environment variables:
54 * NixOS: Add this to `/etc/nixos/configuration.nix`:
55 ```
56 nix.envVars = {
57 NIX_GITHUB_PRIVATE_USERNAME = "your-github-username";
58 NIX_GITHUB_PRIVATE_PASSWORD = "your-github-personal-access-token";
59 };
60 ```
61 * MacOS:
62 ```
63 sudo launchctl setenv NIX_GITHUB_PRIVATE_USERNAME "your-github-username"
64 sudo launchctl setenv NIX_GITHUB_PRIVATE_PASSWORD "your-github-personal-access"
65 sudo launchctl stop org.nixos.nix-daemon
66 sudo launchctl start org.nixos.nix-daemon
67 ```
681. `nix-env -i hub` OR `nix-env -iA nixos.gitAndTools.hub`
691. `hub clone yourusername/yourproject`
70 * NOTE: you must authenticate with hub at least once, because the `ob` command uses `hub` for authentication
71 #TODO: Make ob do this itself (either invoke hub automatically or not depend on hub)
73## Developing an Obelisk project
75To create a new Obelisk project, go to an empty directory and run:
77```
78ob init
79```
81Obelisk 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:
83```
84ob run
85```
87Now go to http://localhost:8000 (or the port specified in `config/common/route`) to access your app.
89Every 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.
91## Deploying
93In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance.
95First create a new EC2 instance:
971. Launch a NixOS 17.09 EC2 instance (we recommend [this AMI](https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#LaunchInstanceWizard:ami=ami-40bee63a))
981. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
991. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.
1001. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80.
102At this stage your instance should be booting and become accessible shortly. Note down the hostname of your instance. It should look like this:
104```
105INSTANCE_HOSTNAME=ec2-??-??-??-??.ca-central-1.compute.amazonaws.com
106```
108Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
109Your 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.
111```
112cd ~/code/myapp
113ob deploy init --ssh-key ~/myaws.pem --hostname ${INSTANCE_HOSTNAME} ~/code/myapp-deploy
114```
116Then go to that created deployment configuration directory, and initiate the deployment:
118```
119cd ~/code/myapp-deploy
120ob deploy push
121```
123`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. It will also configure Nginx so that the public port 80 proxies to the running app.
125At this point you are done. Your app will be accessible at `http://${HOSTNAME}`!
127### Deploying an updated version
129If 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:
131```
132cd ~/code/myapp-deploy
133ob deploy update
134ob deploy push
135```
137## Mobile
138Until Obelisk offers a `ob deploy` equivalent for mobile apps, you are recommended to do it manually as follows.
140### iOS
142#### First time setup
143Development on iOS requires a computer running macOS and an iOS developer account.
144Your 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).
146##### iPhone
1471. Connect the iPhone on which you'd like to run builds - this will open up iTunes.
1481. Click accept to authorize on both the computer and the iPhone.
150##### Xcode
151Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
153These 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`
155More recent Xcodes should also work, as long as one of the SDKs mentioned above has been used.
156To 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.
157```
158open -W Xcode_9.2.xip
159sudo 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
160```
163You can verify that you have correct versions by running
164```
165xcodebuild -showsdks
166```
168##### Certificates
169To deploy and/or package apps, you'll need to inform Apple of your development devices and permissions by
170adding credentials to the correct provisioning profile via the Apple Developer portal.
1721. Open up XCode and go to Preferences - Accounts. Select the organization
173Member role, click Manage Certificates, and add an iOS Development
174certificate.
1751. Go to [developer portal - devices](https://developer.apple.com/account/ios/device/) and add your device.
176To find your device's UDID, select it in iTunes and click the serial number.
1771. Go to [developer portal - development profiles](https://developer.apple.com/account/ios/profile/limited).
178Create a development profile and add your certificate and device.
179Click "Generate" and then download and open the profile.
181#### Building
1821. In your project's `default.nix` set values for `ios.bundleIdentifier` and `ios.bundleName`.
183Ensure that `bundleIdentifier` matches the App ID of the development profile, or that you are using a wildcard profile.
1841. Run `nix-build -A ios.frontend -o result-ios` to build the app. Find it at `result-ios/frontend.app`
186#### Deploying
1871. Connect the registered iPhone.
1881. Find your Apple Team ID in the [developer portal](https://developer.apple.com/account/#/membership).
1891. Run the deploy command with your Team ID:
190```
191result-ios/bin/deploy [TEAM_ID]
192# or in debug mode via lldb:
193result-ios/bin/deploy [TEAM_ID] -d
194```
196#### Packaging
1971. Go to [developer portal - distribution profiles](https://developer.apple.com/account/ios/profile/production).
198Create and download a distribution profile.
1991. Run the package script with your TEAM ID and your distribution profile to create a `.ipa`:
200```
201result-ios/bin/package [TEAM_ID] /path/to/output/.ipa /path/to/profile/file
202```
204#### Debugging
205It's also possible to inspect iOS WkWebView apps once they are installed in the iPhone:
2061. On the desktop, go to Safari > Preferences > Advanced and enable Develop menu.
2071. On the iPhone go to Settings > Safari > Advanced and enable Web Inspector.
2081. Open the app on the iPhone while it is connected to the desktop.
2091. In the desktop's Safari Develop menu, you should see your iPhone. Select the screen under the name of the app.
211### Android
2131. In your project's `default.nix` set a suitable value for `android.applicationId` and `android.displayName`.
2141. Run `nix-build -A android.frontend -o result-android` to build the Android app.
2151. A debug version of the app should be generated at `result-android/android-app-debug.apk`
217Now deploy the built apk file to your Android device:
2191. Enable *USB debugging* in your Android device ([instructions here](https://developer.android.com/studio/debug/dev-options))
2201. Connect the device using USB (be sure to confirm any security prompts on the device)
2211. Run the deploy script: `result-android/bin/deploy`
223This 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`.
225#### Releasing to Play Store
227##### Configure signing
229The previous section would have generated a debug version of the app. In order to build a release version you will need to sign your app. Obelisk can automatically sign the app during build if you provide it with your keystore file in `default.nix`.
231First, if you do not already have a keystore, create it as follows (for more information, see the [Android documentation](https://developer.android.com/studio/publish/app-signing#signing-manually)):
233```
234nix-shell -p androidenv.platformTools --run "keytool -genkey -v -keystore myandroidkey.jks -keyalg RSA -keysize 2048 -validity 10000 -alias myandroidalias"
235```
237(Besure to give an appropriate keystore filename and key alias string above.)
239The `keytool` command will ask you for some details, including a keystore password and a key password (we will use these passwords further below). It will now have created a `myandroidkey.jks` file under the current directory. Move that to somewhere safe, and note down its full path.
241Now edit your project's `default.nix` and tell Obelisk of your app's keystore file. Your `default.nix` should look like this after the edit:
243```nix
244 ...
245 android.applicationId = "com.example.myapp";
246 android.displayName = "My App";
247 android.releaseKey =
248 { storeFile = /path/to/myandroidkey.jks;
249 storePassword = "abcd1234";
250 keyAlias = "myandroidalias";
251 keyPassword = "abcd1234";
252 };
253 ...
254```
256##### Build a release version
258After 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.