git.iko.soy/obelisk
on vs-static-head-2 help sign in
obelisk/README.md
285 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 - [Locally](#locally)
9 - [EC2](#ec2)
10 - [From macOS](#from-macos)
11 - [Deploying an updated version](#deploying-an-updated-version)
12- [Mobile](#mobile)
13 - [iOS](#ios)
14 - [Android](#android)
16## Installing Obelisk
171. [Install Nix](https://nixos.org/nix/).
18 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
191. Set up nix caches
20 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:
21 ```
22 nix.binaryCaches = [ "https://cache.nixos.org/" "https://nixcache.reflex-frp.org" ];
23 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];
24 ```
25 1. If you are using another operating system or linux distribution, ensure that these lines are present in `/etc/nix/nix.conf`:
26 ```
27 substituters = https://cache.nixos.org https://nixcache.reflex-frp.org
28 trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
29 ```
30 * other Linux: enable sandboxing (see https://github.com/obsidiansystems/obelisk/issues/6)
31 ```
32 sandbox = true
33 ```
34 * MacOS: disable sandboxing (there are still some impure dependencies for now)
35 ```
36 sandbox = false
37 ```
38 then restart the nix daemon
39 ```
40 sudo launchctl stop org.nixos.nix-daemon
41 sudo launchctl start org.nixos.nix-daemon
42 ```
431. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`
45### Contributing to Obelisk
47When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:
49```
50nix-shell -A obeliskEnvs.obelisk-backend --run "cd lib/backend && ghcid -c 'cabal new-repl'"
51```
53Or to launch ghcid for `lib/command` project:
55```
56nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid -c 'cabal new-repl'"
57```
59### Accessing private repositories
61To allow the Nix builder to access private git repositories, you must be set up
62to access them via SSH. Follow these steps depending on the platform you need
63access to:
65- [GitHub](https://help.github.com/articles/connecting-to-github-with-ssh/)
66- [GitLab](https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html)
68## Developing an Obelisk project
70To create a new Obelisk project, go to an empty directory and run:
72```
73ob init
74```
76Obelisk 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:
78```
79ob run
80```
82Now go to http://localhost:8000 (or the port specified in `config/common/route`) to access your app.
84Every 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.
86## Deploying
88### Locally
90Build everything:
92```
93nix-build -A exe -o result-exe
94```
96Run the server:
98```
99cd result-exe
100./backend
101```
103### EC2
105In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance.
107First create a new EC2 instance:
1091. 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))
1101. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
1111. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.
1121. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and 443.
114At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.
116Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
117Your 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.
119```
120cd ~/code/myapp
121SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com
122ROUTE=https://myapp.com # Publicly accessible route to your app
123EMAIL=myname@myapp.com
124ob deploy init \
125 --ssh-key ~/myaws.pem \
126 --hostname $SERVER \
127 --route $ROUTE \
128 --admin-email $EMAIL \
129 ~/code/myapp-deploy
130```
132NOTE: HTTPS is enabled by default; to disable https, pass `--disable-https` to the `ob deploy init` command above.
134Then go to that created deployment configuration directory, and initiate the deployment:
136```
137cd ~/code/myapp-deploy
138ob deploy push
139```
141`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`.
143At 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`.
145### From macOS
147Deploying from macOS requires some extra setup:
149- [Install nix-darwin](https://github.com/LnL7/nix-darwin)
150- [Install docker](https://docs.docker.com/)
152Running `ob deploy push` will give you additional setup instructions.
154### Deploying an updated version
156If 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:
158```
159cd ~/code/myapp-deploy
160ob deploy update
161ob deploy push
162```
164## Mobile
165Until Obelisk offers a `ob deploy` equivalent for mobile apps, you are recommended to do it manually as follows.
167### iOS
169#### First time setup
170Development on iOS requires a computer running macOS and an iOS developer account.
171Your 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).
173##### iPhone
1741. Connect the iPhone on which you'd like to run builds - this will open up iTunes.
1751. Click accept to authorize on both the computer and the iPhone.
177##### Xcode
178Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
180These 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`
182More recent Xcodes should also work, as long as one of the SDKs mentioned above has been used.
183To 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.
184```
185open -W Xcode_9.2.xip
186sudo 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
187```
190You can verify that you have correct versions by running
191```
192xcodebuild -showsdks
193```
195##### Certificates
196To deploy and/or package apps, you'll need to inform Apple of your development devices and permissions by
197adding credentials to the correct provisioning profile via the Apple Developer portal.
1991. Open up XCode and go to Preferences - Accounts. Select the organization
200Member role, click Manage Certificates, and add an iOS Development
201certificate.
2021. Go to [developer portal - devices](https://developer.apple.com/account/ios/device/) and add your device.
203To find your device's UDID, select it in iTunes and click the serial number.
2041. Go to [developer portal - development profiles](https://developer.apple.com/account/ios/profile/limited).
205Create a development profile and add your certificate and device.
206Click "Generate" and then download and open the profile.
208#### Building
2091. In your project's `default.nix` set values for `ios.bundleIdentifier` and `ios.bundleName`.
210Ensure that `bundleIdentifier` matches the App ID of the development profile, or that you are using a wildcard profile.
2111. Run `nix-build -A ios.frontend -o result-ios` to build the app. Find it at `result-ios/frontend.app`
213#### Deploying
2141. Connect the registered iPhone.
2151. Find your Apple Team ID in the [developer portal](https://developer.apple.com/account/#/membership).
2161. Run the deploy command with your Team ID:
217```
218result-ios/bin/deploy [TEAM_ID]
219# or in debug mode via lldb:
220result-ios/bin/deploy [TEAM_ID] -d
221```
223#### Packaging
2241. Go to [developer portal - distribution profiles](https://developer.apple.com/account/ios/profile/production).
225Create and download a distribution profile.
2261. Run the package script with your TEAM ID and your distribution profile to create a `.ipa`:
227```
228result-ios/bin/package [TEAM_ID] /path/to/output/.ipa /path/to/profile/file
229```
231#### Debugging
232It's also possible to inspect iOS WkWebView apps once they are installed in the iPhone:
2331. On the desktop, go to Safari > Preferences > Advanced and enable Develop menu.
2341. On the iPhone go to Settings > Safari > Advanced and enable Web Inspector.
2351. Open the app on the iPhone while it is connected to the desktop.
2361. In the desktop's Safari Develop menu, you should see your iPhone. Select the screen under the name of the app.
238### Android
2401. In your project's `default.nix` set a suitable value for `android.applicationId` and `android.displayName`.
2411. Run `nix-build -A android.frontend -o result-android` to build the Android app.
2421. A debug version of the app should be generated at `result-android/android-app-debug.apk`
244Now deploy the built apk file to your Android device:
2461. Enable *USB debugging* in your Android device ([instructions here](https://developer.android.com/studio/debug/dev-options))
2471. Connect the device using USB (be sure to confirm any security prompts on the device)
2481. Run the deploy script: `result-android/bin/deploy`
250This 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`.
252#### Releasing to Play Store
254##### Configure signing
256The 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`.
258First, 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)):
260```
261nix-shell -p androidenv.platformTools --run "keytool -genkey -v -keystore myandroidkey.jks -keyalg RSA -keysize 2048 -validity 10000 -alias myandroidalias"
262```
264(Be sure to give an appropriate keystore filename and key alias string above.)
266The `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.
268Now 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:
270```nix
271 ...
272 android.applicationId = "com.example.myapp";
273 android.displayName = "My App";
274 android.releaseKey =
275 { storeFile = /path/to/myandroidkey.jks;
276 storePassword = "abcd1234";
277 keyAlias = "myandroidalias";
278 keyPassword = "abcd1234";
279 };
280 ...
281```
283##### Build a release version
285After 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.